Xbase++ Requires Chilkat v11.0.0+
Xbase++
Amazon Pay - Cancel Charge
See more Amazon Pay Examples
Moves Charge to Canceled state and releases any authorized payments.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oJson
LOCAL oSbRequestBody
LOCAL oPrivKey
LOCAL cPublicKeyId
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cChargeId
LOCAL cChargePermissionId
LOCAL cChargeAmountAmount
LOCAL cChargeAmountCurrencyCode
LOCAL cCaptureAmountAmount
LOCAL cCaptureAmountCurrencyCode
LOCAL cRefundedAmountAmount
LOCAL cRefundedAmountCurrencyCode
LOCAL cConvertedAmount
LOCAL cConversionRate
LOCAL cSoftDescriptor
LOCAL cMerchantMetadata
LOCAL cProviderMetadataProviderReferenceId
LOCAL cStatusDetailsState
LOCAL cStatusDetailsReasonCode
LOCAL cStatusDetailsReasonDescription
LOCAL cStatusDetailsLastUpdatedTimestamp
LOCAL cCreationTimestamp
LOCAL cExpirationTimestamp
LOCAL cReleaseEnvironment
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/charges/:chargeId/cancel" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
// "cancellationReason": "REASON DESCRIPTION"
// }'
// 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.
// {
// "cancellationReason": "REASON DESCRIPTION"
// }
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("cancellationReason", "REASON DESCRIPTION")
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.
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 chargeId here:
nSuccess := oHttp:SetUrlVar("chargeId", "bd504926-f659-4ad7-a1a9-9a747aaf5275")
// 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/charges/{$chargeId}/cancel", 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)
// {
// "chargeId": "P21-1111111-1111111-C111111",
// "chargePermissionId": "P21-1111111-1111111",
// "chargeAmount": {
// "amount": "14.00",
// "currencyCode": "USD"
// },
// "captureAmount": {
// "amount": "14.00",
// "currencyCode": "USD"
// },
// "refundedAmount": {
// "amount": "0.00",
// "currencyCode": "USD"
// },
// "convertedAmount": "14.00",
// "conversionRate": "1.00",
// "softDescriptor": "SOFT DESCRIPTOR",
// "merchantMetadata": null,
// "providerMetadata": {
// "providerReferenceId": null
// },
// "statusDetails": {
// "state": "Canceled",
// "reasonCode": null,
// "reasonDescription": null,
// "lastUpdatedTimestamp": "20190714T155300Z"
// },
// "creationTimestamp": "20190714T155300Z",
// "expirationTimestamp": "20190715T155300Z",
// "releaseEnvironment": "Sandbox"
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
cChargeId := oJResp:StringOf("chargeId")
cChargePermissionId := oJResp:StringOf("chargePermissionId")
cChargeAmountAmount := oJResp:StringOf("chargeAmount.amount")
cChargeAmountCurrencyCode := oJResp:StringOf("chargeAmount.currencyCode")
cCaptureAmountAmount := oJResp:StringOf("captureAmount.amount")
cCaptureAmountCurrencyCode := oJResp:StringOf("captureAmount.currencyCode")
cRefundedAmountAmount := oJResp:StringOf("refundedAmount.amount")
cRefundedAmountCurrencyCode := oJResp:StringOf("refundedAmount.currencyCode")
cConvertedAmount := oJResp:StringOf("convertedAmount")
cConversionRate := oJResp:StringOf("conversionRate")
cSoftDescriptor := oJResp:StringOf("softDescriptor")
cMerchantMetadata := oJResp:StringOf("merchantMetadata")
cProviderMetadataProviderReferenceId := oJResp:StringOf("providerMetadata.providerReferenceId")
cStatusDetailsState := oJResp:StringOf("statusDetails.state")
cStatusDetailsReasonCode := oJResp:StringOf("statusDetails.reasonCode")
cStatusDetailsReasonDescription := oJResp:StringOf("statusDetails.reasonDescription")
cStatusDetailsLastUpdatedTimestamp := oJResp:StringOf("statusDetails.lastUpdatedTimestamp")
cCreationTimestamp := oJResp:StringOf("creationTimestamp")
cExpirationTimestamp := oJResp:StringOf("expirationTimestamp")
cReleaseEnvironment := oJResp:StringOf("releaseEnvironment")
oHttp:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oPrivKey:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()