Xbase++ Requires Chilkat v11.0.0+
Xbase++
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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oJson
LOCAL oSbRequestBody
LOCAL oPrivKey
LOCAL cPublicKeyId
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cPaymentDescriptor
LOCAL cReasonCode
LOCAL cReasonDescription
LOCAL cChargePermissionId
LOCAL cChargePermissionReferenceId
LOCAL cBuyerBuyerId
LOCAL cBuyerName
LOCAL cBuyerEmail
LOCAL cBuyerPhoneNumber
LOCAL cBuyerPrimeMembershipTypes
LOCAL cReleaseEnvironment
LOCAL cShippingAddressName
LOCAL cShippingAddressAddressLine1
LOCAL cShippingAddressAddressLine2
LOCAL cShippingAddressAddressLine3
LOCAL cShippingAddressCity
LOCAL cShippingAddressCounty
LOCAL cShippingAddressDistrict
LOCAL cShippingAddressStateOrRegion
LOCAL cShippingAddressPostalCode
LOCAL cShippingAddressCountryCode
LOCAL cShippingAddressPhoneNumber
LOCAL cBillingAddressName
LOCAL cBillingAddressAddressLine1
LOCAL cBillingAddressAddressLine2
LOCAL cBillingAddressAddressLine3
LOCAL cBillingAddressCity
LOCAL cBillingAddressCounty
LOCAL cBillingAddressDistrict
LOCAL cBillingAddressStateOrRegion
LOCAL cBillingAddressPostalCode
LOCAL cBillingAddressCountryCode
LOCAL cBillingAddressPhoneNumber
LOCAL cStatusDetailsState
LOCAL cStatusDetailsLastUpdatedTimestamp
LOCAL cCreationTimestamp
LOCAL cExpirationTimestamp
LOCAL cMerchantMetadataMerchantReferenceId
LOCAL cMerchantMetadataMerchantStoreName
LOCAL cMerchantMetadataNoteToBuyer
LOCAL cMerchantMetadataCustomInformation
LOCAL cPlatformId
LOCAL cLimitsAmountLimitAmount
LOCAL cLimitsAmountLimitCurrencyCode
LOCAL cLimitsAmountBalanceAmount
LOCAL cLimitsAmountBalanceCurrencyCode
LOCAL cPresentmentCurrency
LOCAL i
LOCAL nCount_i
nSuccess := 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oHttp := CreateObject("Chilkat.Http")
// 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
// }
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("closureReason", "No more charges required")
oJson:UpdateBool("cancelPendingCharges", 0)
oSbRequestBody := CreateObject("Chilkat.StringBuilder")
oJson:EmitSb(oSbRequestBody)
// 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.
oPrivKey := CreateObject("Chilkat.PrivateKey")
nSuccess := oPrivKey:LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
IF (nSuccess == 0)
? oPrivKey:LastErrorText
oHttp:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oPrivKey:destroy()
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
cPublicKeyId := "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
nSuccess := oHttp:SetAuthPrivateKey(cPublicKeyId, oPrivKey)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oPrivKey:destroy()
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
oHttp:Accept := "application/json"
// Use the actual chargePermissionId here:
nSuccess := oHttp:SetUrlVar("chargePermissionId", "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
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpSb("DELETE", "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close", oSbRequestBody, "utf-8", "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oPrivKey:destroy()
oResp:destroy()
RETURN
ENDIF
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0
// If the status code is not equal to 200, this will display error information.
? "Response Body:"
? oJResp:Emit()
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode != 200)
? "Failed."
oHttp:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oPrivKey:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()
RETURN
ENDIF
// 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
cChargePermissionId := oJResp:StringOf("chargePermissionId")
cChargePermissionReferenceId := oJResp:StringOf("chargePermissionReferenceId")
cBuyerBuyerId := oJResp:StringOf("buyer.buyerId")
cBuyerName := oJResp:StringOf("buyer.name")
cBuyerEmail := oJResp:StringOf("buyer.email")
cBuyerPhoneNumber := oJResp:StringOf("buyer.phoneNumber")
cBuyerPrimeMembershipTypes := oJResp:StringOf("buyer.primeMembershipTypes")
cReleaseEnvironment := oJResp:StringOf("releaseEnvironment")
cShippingAddressName := oJResp:StringOf("shippingAddress.name")
cShippingAddressAddressLine1 := oJResp:StringOf("shippingAddress.addressLine1")
cShippingAddressAddressLine2 := oJResp:StringOf("shippingAddress.addressLine2")
cShippingAddressAddressLine3 := oJResp:StringOf("shippingAddress.addressLine3")
cShippingAddressCity := oJResp:StringOf("shippingAddress.city")
cShippingAddressCounty := oJResp:StringOf("shippingAddress.county")
cShippingAddressDistrict := oJResp:StringOf("shippingAddress.district")
cShippingAddressStateOrRegion := oJResp:StringOf("shippingAddress.stateOrRegion")
cShippingAddressPostalCode := oJResp:StringOf("shippingAddress.postalCode")
cShippingAddressCountryCode := oJResp:StringOf("shippingAddress.countryCode")
cShippingAddressPhoneNumber := oJResp:StringOf("shippingAddress.phoneNumber")
cBillingAddressName := oJResp:StringOf("billingAddress.name")
cBillingAddressAddressLine1 := oJResp:StringOf("billingAddress.addressLine1")
cBillingAddressAddressLine2 := oJResp:StringOf("billingAddress.addressLine2")
cBillingAddressAddressLine3 := oJResp:StringOf("billingAddress.addressLine3")
cBillingAddressCity := oJResp:StringOf("billingAddress.city")
cBillingAddressCounty := oJResp:StringOf("billingAddress.county")
cBillingAddressDistrict := oJResp:StringOf("billingAddress.district")
cBillingAddressStateOrRegion := oJResp:StringOf("billingAddress.stateOrRegion")
cBillingAddressPostalCode := oJResp:StringOf("billingAddress.postalCode")
cBillingAddressCountryCode := oJResp:StringOf("billingAddress.countryCode")
cBillingAddressPhoneNumber := oJResp:StringOf("billingAddress.phoneNumber")
cStatusDetailsState := oJResp:StringOf("statusDetails.state")
cStatusDetailsLastUpdatedTimestamp := oJResp:StringOf("statusDetails.lastUpdatedTimestamp")
cCreationTimestamp := oJResp:StringOf("creationTimestamp")
cExpirationTimestamp := oJResp:StringOf("expirationTimestamp")
cMerchantMetadataMerchantReferenceId := oJResp:StringOf("merchantMetadata.merchantReferenceId")
cMerchantMetadataMerchantStoreName := oJResp:StringOf("merchantMetadata.merchantStoreName")
cMerchantMetadataNoteToBuyer := oJResp:StringOf("merchantMetadata.noteToBuyer")
cMerchantMetadataCustomInformation := oJResp:StringOf("merchantMetadata.customInformation")
cPlatformId := oJResp:StringOf("platformId")
cLimitsAmountLimitAmount := oJResp:StringOf("limits.amountLimit.amount")
cLimitsAmountLimitCurrencyCode := oJResp:StringOf("limits.amountLimit.currencyCode")
cLimitsAmountBalanceAmount := oJResp:StringOf("limits.amountBalance.amount")
cLimitsAmountBalanceCurrencyCode := oJResp:StringOf("limits.amountBalance.currencyCode")
cPresentmentCurrency := oJResp:StringOf("presentmentCurrency")
i := 0
nCount_i := oJResp:SizeOfArray("paymentPreferences")
DO WHILE i < nCount_i
oJResp:I := i
cPaymentDescriptor := oJResp:StringOf("paymentPreferences[i].paymentDescriptor")
i := i + 1
ENDDO
i := 0
nCount_i := oJResp:SizeOfArray("statusDetails.reasons")
DO WHILE i < nCount_i
oJResp:I := i
cReasonCode := oJResp:StringOf("statusDetails.reasons[i].reasonCode")
cReasonDescription := oJResp:StringOf("statusDetails.reasons[i].reasonDescription")
i := i + 1
ENDDO
oHttp:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oPrivKey:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()