DataFlex
DataFlex
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 DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vPrivKey
Handle hoPrivKey
String sPublicKeyId
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sPaymentDescriptor
String sReasonCode
String sReasonDescription
String sChargePermissionId
String sChargePermissionReferenceId
String sBuyerBuyerId
String sBuyerName
String sBuyerEmail
String sBuyerPhoneNumber
String sBuyerPrimeMembershipTypes
String sReleaseEnvironment
String sShippingAddressName
String sShippingAddressAddressLine1
String sShippingAddressAddressLine2
String sShippingAddressAddressLine3
String sShippingAddressCity
String sShippingAddressCounty
String sShippingAddressDistrict
String sShippingAddressStateOrRegion
String sShippingAddressPostalCode
String sShippingAddressCountryCode
String sShippingAddressPhoneNumber
String sBillingAddressName
String sBillingAddressAddressLine1
String sBillingAddressAddressLine2
String sBillingAddressAddressLine3
String sBillingAddressCity
String sBillingAddressCounty
String sBillingAddressDistrict
String sBillingAddressStateOrRegion
String sBillingAddressPostalCode
String sBillingAddressCountryCode
String sBillingAddressPhoneNumber
String sStatusDetailsState
String sStatusDetailsLastUpdatedTimestamp
String sCreationTimestamp
String sExpirationTimestamp
String sMerchantMetadataMerchantReferenceId
String sMerchantMetadataMerchantStoreName
String sMerchantMetadataNoteToBuyer
String sMerchantMetadataCustomInformation
String sPlatformId
String sLimitsAmountLimitAmount
String sLimitsAmountLimitCurrencyCode
String sLimitsAmountBalanceAmount
String sLimitsAmountBalanceCurrencyCode
String sPresentmentCurrency
Integer i
Integer iCount_i
String sTemp1
Move False To iSuccess
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "closureReason" "No more charges required" To iSuccess
Get ComUpdateBool Of hoJson "cancelPendingCharges" False To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
// 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.
Get Create (RefClass(cComChilkatPrivateKey)) To hoPrivKey
If (Not(IsComObjectCreated(hoPrivKey))) Begin
Send CreateComObject of hoPrivKey
End
Get ComLoadPemFile Of hoPrivKey "C:/someDir/myAmazonPayPrivateKey.pem" To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoPrivKey To sTemp1
Showln sTemp1
Procedure_Return
End
// 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
Move "SANDBOX-AHEGSJCM3L2S637RBGABLAFW" To sPublicKeyId
Get pvComObject of hoPrivKey to vPrivKey
Get ComSetAuthPrivateKey Of hoHttp sPublicKeyId vPrivKey To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
// 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
Set ComAccept Of hoHttp To "application/json"
// Use the actual chargePermissionId here:
Get ComSetUrlVar Of hoHttp "chargePermissionId" "P21-1111111-1111111" To iSuccess
// 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
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get pvComObject of hoResp to vResp
Get ComHttpSb Of hoHttp "DELETE" "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close" vSbRequestBody "utf-8" "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
// If the status code is not equal to 200, this will display error information.
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode <> 200) Begin
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "chargePermissionId" To sChargePermissionId
Get ComStringOf Of hoJResp "chargePermissionReferenceId" To sChargePermissionReferenceId
Get ComStringOf Of hoJResp "buyer.buyerId" To sBuyerBuyerId
Get ComStringOf Of hoJResp "buyer.name" To sBuyerName
Get ComStringOf Of hoJResp "buyer.email" To sBuyerEmail
Get ComStringOf Of hoJResp "buyer.phoneNumber" To sBuyerPhoneNumber
Get ComStringOf Of hoJResp "buyer.primeMembershipTypes" To sBuyerPrimeMembershipTypes
Get ComStringOf Of hoJResp "releaseEnvironment" To sReleaseEnvironment
Get ComStringOf Of hoJResp "shippingAddress.name" To sShippingAddressName
Get ComStringOf Of hoJResp "shippingAddress.addressLine1" To sShippingAddressAddressLine1
Get ComStringOf Of hoJResp "shippingAddress.addressLine2" To sShippingAddressAddressLine2
Get ComStringOf Of hoJResp "shippingAddress.addressLine3" To sShippingAddressAddressLine3
Get ComStringOf Of hoJResp "shippingAddress.city" To sShippingAddressCity
Get ComStringOf Of hoJResp "shippingAddress.county" To sShippingAddressCounty
Get ComStringOf Of hoJResp "shippingAddress.district" To sShippingAddressDistrict
Get ComStringOf Of hoJResp "shippingAddress.stateOrRegion" To sShippingAddressStateOrRegion
Get ComStringOf Of hoJResp "shippingAddress.postalCode" To sShippingAddressPostalCode
Get ComStringOf Of hoJResp "shippingAddress.countryCode" To sShippingAddressCountryCode
Get ComStringOf Of hoJResp "shippingAddress.phoneNumber" To sShippingAddressPhoneNumber
Get ComStringOf Of hoJResp "billingAddress.name" To sBillingAddressName
Get ComStringOf Of hoJResp "billingAddress.addressLine1" To sBillingAddressAddressLine1
Get ComStringOf Of hoJResp "billingAddress.addressLine2" To sBillingAddressAddressLine2
Get ComStringOf Of hoJResp "billingAddress.addressLine3" To sBillingAddressAddressLine3
Get ComStringOf Of hoJResp "billingAddress.city" To sBillingAddressCity
Get ComStringOf Of hoJResp "billingAddress.county" To sBillingAddressCounty
Get ComStringOf Of hoJResp "billingAddress.district" To sBillingAddressDistrict
Get ComStringOf Of hoJResp "billingAddress.stateOrRegion" To sBillingAddressStateOrRegion
Get ComStringOf Of hoJResp "billingAddress.postalCode" To sBillingAddressPostalCode
Get ComStringOf Of hoJResp "billingAddress.countryCode" To sBillingAddressCountryCode
Get ComStringOf Of hoJResp "billingAddress.phoneNumber" To sBillingAddressPhoneNumber
Get ComStringOf Of hoJResp "statusDetails.state" To sStatusDetailsState
Get ComStringOf Of hoJResp "statusDetails.lastUpdatedTimestamp" To sStatusDetailsLastUpdatedTimestamp
Get ComStringOf Of hoJResp "creationTimestamp" To sCreationTimestamp
Get ComStringOf Of hoJResp "expirationTimestamp" To sExpirationTimestamp
Get ComStringOf Of hoJResp "merchantMetadata.merchantReferenceId" To sMerchantMetadataMerchantReferenceId
Get ComStringOf Of hoJResp "merchantMetadata.merchantStoreName" To sMerchantMetadataMerchantStoreName
Get ComStringOf Of hoJResp "merchantMetadata.noteToBuyer" To sMerchantMetadataNoteToBuyer
Get ComStringOf Of hoJResp "merchantMetadata.customInformation" To sMerchantMetadataCustomInformation
Get ComStringOf Of hoJResp "platformId" To sPlatformId
Get ComStringOf Of hoJResp "limits.amountLimit.amount" To sLimitsAmountLimitAmount
Get ComStringOf Of hoJResp "limits.amountLimit.currencyCode" To sLimitsAmountLimitCurrencyCode
Get ComStringOf Of hoJResp "limits.amountBalance.amount" To sLimitsAmountBalanceAmount
Get ComStringOf Of hoJResp "limits.amountBalance.currencyCode" To sLimitsAmountBalanceCurrencyCode
Get ComStringOf Of hoJResp "presentmentCurrency" To sPresentmentCurrency
Move 0 To i
Get ComSizeOfArray Of hoJResp "paymentPreferences" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "paymentPreferences[i].paymentDescriptor" To sPaymentDescriptor
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "statusDetails.reasons" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "statusDetails.reasons[i].reasonCode" To sReasonCode
Get ComStringOf Of hoJResp "statusDetails.reasons[i].reasonDescription" To sReasonDescription
Move (i + 1) To i
Loop
End_Procedure