(Lianja) 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.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#close-charge-permission

Chilkat Lianja Extension Download Chilkat Lianja Extension

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

// 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
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("closureReason","No more charges required")
loJson.UpdateBool("cancelPendingCharges",.F.)

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

// 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.
loPrivKey = createobject("CkPrivateKey")
llSuccess = loPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if (llSuccess = .F.) then
    ? loPrivKey.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    return
endif

// 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
lcPublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
llSuccess = loHttp.SetAuthPrivateKey(lcPublicKeyId,loPrivKey)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    return
endif

// 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

loHttp.Accept = "application/json"

// Use the actual chargePermissionId here:
llSuccess = loHttp.SetUrlVar("chargePermissionId","CHARGE_PERMISSION_ID")
// To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
loResp = loHttp.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

// If the status code is not equal to 200, this will display error information.
? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode <> 200) then
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcChargePermissionId = loJResp.StringOf("chargePermissionId")
lcChargePermissionReferenceId = loJResp.StringOf("chargePermissionReferenceId")
lcBuyerBuyerId = loJResp.StringOf("buyer.buyerId")
lcBuyerName = loJResp.StringOf("buyer.name")
lcBuyerEmail = loJResp.StringOf("buyer.email")
lcBuyerPhoneNumber = loJResp.StringOf("buyer.phoneNumber")
lcBuyerPrimeMembershipTypes = loJResp.StringOf("buyer.primeMembershipTypes")
lcReleaseEnvironment = loJResp.StringOf("releaseEnvironment")
lcShippingAddressName = loJResp.StringOf("shippingAddress.name")
lcShippingAddressAddressLine1 = loJResp.StringOf("shippingAddress.addressLine1")
lcShippingAddressAddressLine2 = loJResp.StringOf("shippingAddress.addressLine2")
lcShippingAddressAddressLine3 = loJResp.StringOf("shippingAddress.addressLine3")
lcShippingAddressCity = loJResp.StringOf("shippingAddress.city")
lcShippingAddressCounty = loJResp.StringOf("shippingAddress.county")
lcShippingAddressDistrict = loJResp.StringOf("shippingAddress.district")
lcShippingAddressStateOrRegion = loJResp.StringOf("shippingAddress.stateOrRegion")
lcShippingAddressPostalCode = loJResp.StringOf("shippingAddress.postalCode")
lcShippingAddressCountryCode = loJResp.StringOf("shippingAddress.countryCode")
lcShippingAddressPhoneNumber = loJResp.StringOf("shippingAddress.phoneNumber")
lcBillingAddressName = loJResp.StringOf("billingAddress.name")
lcBillingAddressAddressLine1 = loJResp.StringOf("billingAddress.addressLine1")
lcBillingAddressAddressLine2 = loJResp.StringOf("billingAddress.addressLine2")
lcBillingAddressAddressLine3 = loJResp.StringOf("billingAddress.addressLine3")
lcBillingAddressCity = loJResp.StringOf("billingAddress.city")
lcBillingAddressCounty = loJResp.StringOf("billingAddress.county")
lcBillingAddressDistrict = loJResp.StringOf("billingAddress.district")
lcBillingAddressStateOrRegion = loJResp.StringOf("billingAddress.stateOrRegion")
lcBillingAddressPostalCode = loJResp.StringOf("billingAddress.postalCode")
lcBillingAddressCountryCode = loJResp.StringOf("billingAddress.countryCode")
lcBillingAddressPhoneNumber = loJResp.StringOf("billingAddress.phoneNumber")
lcStatusDetailsState = loJResp.StringOf("statusDetails.state")
lcStatusDetailsLastUpdatedTimestamp = loJResp.StringOf("statusDetails.lastUpdatedTimestamp")
lcCreationTimestamp = loJResp.StringOf("creationTimestamp")
lcExpirationTimestamp = loJResp.StringOf("expirationTimestamp")
lcMerchantMetadataMerchantReferenceId = loJResp.StringOf("merchantMetadata.merchantReferenceId")
lcMerchantMetadataMerchantStoreName = loJResp.StringOf("merchantMetadata.merchantStoreName")
lcMerchantMetadataNoteToBuyer = loJResp.StringOf("merchantMetadata.noteToBuyer")
lcMerchantMetadataCustomInformation = loJResp.StringOf("merchantMetadata.customInformation")
lcPlatformId = loJResp.StringOf("platformId")
lcLimitsAmountLimitAmount = loJResp.StringOf("limits.amountLimit.amount")
lcLimitsAmountLimitCurrencyCode = loJResp.StringOf("limits.amountLimit.currencyCode")
lcLimitsAmountBalanceAmount = loJResp.StringOf("limits.amountBalance.amount")
lcLimitsAmountBalanceCurrencyCode = loJResp.StringOf("limits.amountBalance.currencyCode")
lcPresentmentCurrency = loJResp.StringOf("presentmentCurrency")
i = 0
lnCount_i = loJResp.SizeOfArray("paymentPreferences")
do while i < lnCount_i
    loJResp.I = i
    lcPaymentDescriptor = loJResp.StringOf("paymentPreferences[i].paymentDescriptor")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("statusDetails.reasons")
do while i < lnCount_i
    loJResp.I = i
    lcReasonCode = loJResp.StringOf("statusDetails.reasons[i].reasonCode")
    lcReasonDescription = loJResp.StringOf("statusDetails.reasons[i].reasonDescription")
    i = i + 1
enddo


release loHttp
release loJson
release loSbRequestBody
release loPrivKey
release loSbResponseBody
release loJResp