Sample code for 30+ languages & platforms
Lianja Requires Chilkat v11.0.0+

Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

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

loJson = createobject("CkJsonObject")
loJson.UpdateString("cancellationReason","REASON DESCRIPTION")

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.
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 chargeId here:
llSuccess = loHttp.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
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel",loSbRequestBody,"utf-8","application/json",loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    release loResp
    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 loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    release loResp
    release loSbResponseBody
    release loJResp
    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

lcChargeId = loJResp.StringOf("chargeId")
lcChargePermissionId = loJResp.StringOf("chargePermissionId")
lcChargeAmountAmount = loJResp.StringOf("chargeAmount.amount")
lcChargeAmountCurrencyCode = loJResp.StringOf("chargeAmount.currencyCode")
lcCaptureAmountAmount = loJResp.StringOf("captureAmount.amount")
lcCaptureAmountCurrencyCode = loJResp.StringOf("captureAmount.currencyCode")
lcRefundedAmountAmount = loJResp.StringOf("refundedAmount.amount")
lcRefundedAmountCurrencyCode = loJResp.StringOf("refundedAmount.currencyCode")
lcConvertedAmount = loJResp.StringOf("convertedAmount")
lcConversionRate = loJResp.StringOf("conversionRate")
lcSoftDescriptor = loJResp.StringOf("softDescriptor")
lcMerchantMetadata = loJResp.StringOf("merchantMetadata")
lcProviderMetadataProviderReferenceId = loJResp.StringOf("providerMetadata.providerReferenceId")
lcStatusDetailsState = loJResp.StringOf("statusDetails.state")
lcStatusDetailsReasonCode = loJResp.StringOf("statusDetails.reasonCode")
lcStatusDetailsReasonDescription = loJResp.StringOf("statusDetails.reasonDescription")
lcStatusDetailsLastUpdatedTimestamp = loJResp.StringOf("statusDetails.lastUpdatedTimestamp")
lcCreationTimestamp = loJResp.StringOf("creationTimestamp")
lcExpirationTimestamp = loJResp.StringOf("expirationTimestamp")
lcReleaseEnvironment = loJResp.StringOf("releaseEnvironment")


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