Swift Requires Chilkat v11.0.0+
Swift
Amazon Pay - Close Charge Permission
See more Amazon Pay Examples
Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = false
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId/close" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
// "closureReason": "No more charges required",
// "cancelPendingCharges": false
// }'
// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "closureReason": "No more charges required",
// "cancelPendingCharges": false
// }
let json = CkoJsonObject()!
json.updateString(jsonPath: "closureReason", value: "No more charges required")
json.updateBool(jsonPath: "cancelPendingCharges", value: false)
let sbRequestBody = CkoStringBuilder()!
json.emitSb(sb: sbRequestBody)
// Load your Amazon Pay private key.
// There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
// or from in-memory strings or bytes.
let privKey = CkoPrivateKey()!
success = privKey.loadPemFile(path: "C:/someDir/myAmazonPayPrivateKey.pem")
if success == false {
print("\(privKey.lastErrorText!)")
return
}
// Provide your Amazon Pay private key and Public Key ID
// Use your public key ID here. It must be the one associated with the private key.
// Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
var publicKeyId: String? = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.setAuthPrivateKey(publicKeyId: publicKeyId, privKey: privKey)
if success == false {
print("\(http.lastErrorText!)")
return
}
// Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
// and will also sign the request. Nothing more is needed.
// Chilkat automatically generates and adds the following headers:
//
// x-amz-pay-date
// x-amz-pay-host
// x-amz-pay-region
// Authorization
http.accept = "application/json"
// Use the actual chargePermissionId here:
success = http.setUrlVar(name: "chargePermissionId", value: "P21-1111111-1111111")
// To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
let resp = CkoHttpResponse()!
success = http.httpSb(verb: "DELETE", url: "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close", sb: sbRequestBody, charset: "utf-8", contentType: "application/json", response: resp)
if success == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp.getBodySb(sb: sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sb: sbResponseBody)
jResp.emitCompact = false
// If the status code is not equal to 200, this will display error information.
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode != 200 {
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "chargePermissionId": "chargePermission-1",
// "chargePermissionReferenceId": null,
// "buyer": {
// "buyerId": "buyerId",
// "name": "name-1",
// "email": "name@amazon.com",
// "phoneNumber": "800-000-0000",
// "primeMembershipTypes": null
// },
// "releaseEnvironment": "Live",
// "shippingAddress": { // Null for PayOnly product type
// "name": "Work",
// "addressLine1": "440 Terry Ave",
// "addressLine2": "",
// "addressLine3": "",
// "city": "Seattle",
// "county": "King",
// "district": "Seattle",
// "stateOrRegion": "WA",
// "postalCode": "98121",
// "countryCode": "US",
// "phoneNumber": "800-000-0000"
// },
// "billingAddress": { // Only available in EU or for PayOnly product type
// "name": "Work",
// "addressLine1": "440 Terry Ave",
// "addressLine2": "",
// "addressLine3": "",
// "city": "Seattle",
// "county": "King",
// "district": "Seattle",
// "stateOrRegion": "WA",
// "postalCode": "98121",
// "countryCode": "US",
// "phoneNumber": "800-000-0000"
// },
// "paymentPreferences": [
// {
// "paymentDescriptor": null
// }],
// "statusDetails": {
// "state": "Closed",
// "reasons":
// [{
// "reasonCode": null,
// "reasonDescription": null
// }],
// "lastUpdatedTimestamp": "20190714T155300Z"
// },
// "creationTimestamp": "20190714T155300Z",
// "expirationTimestamp": "20190715T155300Z",
// "merchantMetadata":{
// "merchantReferenceId": "123-77-876",
// "merchantStoreName": "AmazonTestStoreFront",
// "noteToBuyer": "merchantNoteForBuyer",
// "customInformation": "This is custom information"
// },
// "platformId": "SPId",
// "limits": {
// "amountLimit": {
// "amount": "14.00",
// "currencyCode": "USD"
// },
// "amountBalance": {
// "amount": "14.00",
// "currencyCode": "USD"
// }
// },
// "presentmentCurrency": "USD"
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
var paymentDescriptor: String?
var reasonCode: String?
var reasonDescription: String?
var chargePermissionId: String? = jResp.string(of: "chargePermissionId")
var chargePermissionReferenceId: String? = jResp.string(of: "chargePermissionReferenceId")
var buyerBuyerId: String? = jResp.string(of: "buyer.buyerId")
var buyerName: String? = jResp.string(of: "buyer.name")
var buyerEmail: String? = jResp.string(of: "buyer.email")
var buyerPhoneNumber: String? = jResp.string(of: "buyer.phoneNumber")
var buyerPrimeMembershipTypes: String? = jResp.string(of: "buyer.primeMembershipTypes")
var releaseEnvironment: String? = jResp.string(of: "releaseEnvironment")
var shippingAddressName: String? = jResp.string(of: "shippingAddress.name")
var shippingAddressAddressLine1: String? = jResp.string(of: "shippingAddress.addressLine1")
var shippingAddressAddressLine2: String? = jResp.string(of: "shippingAddress.addressLine2")
var shippingAddressAddressLine3: String? = jResp.string(of: "shippingAddress.addressLine3")
var shippingAddressCity: String? = jResp.string(of: "shippingAddress.city")
var shippingAddressCounty: String? = jResp.string(of: "shippingAddress.county")
var shippingAddressDistrict: String? = jResp.string(of: "shippingAddress.district")
var shippingAddressStateOrRegion: String? = jResp.string(of: "shippingAddress.stateOrRegion")
var shippingAddressPostalCode: String? = jResp.string(of: "shippingAddress.postalCode")
var shippingAddressCountryCode: String? = jResp.string(of: "shippingAddress.countryCode")
var shippingAddressPhoneNumber: String? = jResp.string(of: "shippingAddress.phoneNumber")
var billingAddressName: String? = jResp.string(of: "billingAddress.name")
var billingAddressAddressLine1: String? = jResp.string(of: "billingAddress.addressLine1")
var billingAddressAddressLine2: String? = jResp.string(of: "billingAddress.addressLine2")
var billingAddressAddressLine3: String? = jResp.string(of: "billingAddress.addressLine3")
var billingAddressCity: String? = jResp.string(of: "billingAddress.city")
var billingAddressCounty: String? = jResp.string(of: "billingAddress.county")
var billingAddressDistrict: String? = jResp.string(of: "billingAddress.district")
var billingAddressStateOrRegion: String? = jResp.string(of: "billingAddress.stateOrRegion")
var billingAddressPostalCode: String? = jResp.string(of: "billingAddress.postalCode")
var billingAddressCountryCode: String? = jResp.string(of: "billingAddress.countryCode")
var billingAddressPhoneNumber: String? = jResp.string(of: "billingAddress.phoneNumber")
var statusDetailsState: String? = jResp.string(of: "statusDetails.state")
var statusDetailsLastUpdatedTimestamp: String? = jResp.string(of: "statusDetails.lastUpdatedTimestamp")
var creationTimestamp: String? = jResp.string(of: "creationTimestamp")
var expirationTimestamp: String? = jResp.string(of: "expirationTimestamp")
var merchantMetadataMerchantReferenceId: String? = jResp.string(of: "merchantMetadata.merchantReferenceId")
var merchantMetadataMerchantStoreName: String? = jResp.string(of: "merchantMetadata.merchantStoreName")
var merchantMetadataNoteToBuyer: String? = jResp.string(of: "merchantMetadata.noteToBuyer")
var merchantMetadataCustomInformation: String? = jResp.string(of: "merchantMetadata.customInformation")
var platformId: String? = jResp.string(of: "platformId")
var limitsAmountLimitAmount: String? = jResp.string(of: "limits.amountLimit.amount")
var limitsAmountLimitCurrencyCode: String? = jResp.string(of: "limits.amountLimit.currencyCode")
var limitsAmountBalanceAmount: String? = jResp.string(of: "limits.amountBalance.amount")
var limitsAmountBalanceCurrencyCode: String? = jResp.string(of: "limits.amountBalance.currencyCode")
var presentmentCurrency: String? = jResp.string(of: "presentmentCurrency")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "paymentPreferences").intValue
while i < count_i {
jResp.i = i
paymentDescriptor = jResp.string(of: "paymentPreferences[i].paymentDescriptor")
i = i + 1
}
i = 0
count_i = jResp.size(ofArray: "statusDetails.reasons").intValue
while i < count_i {
jResp.i = i
reasonCode = jResp.string(of: "statusDetails.reasons[i].reasonCode")
reasonDescription = jResp.string(of: "statusDetails.reasons[i].reasonDescription")
i = i + 1
}
}