(Visual FoxPro) Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loPrivKey
LOCAL lcPublicKeyId
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcChargeId
LOCAL lcChargePermissionId
LOCAL lcChargeAmountAmount
LOCAL lcChargeAmountCurrencyCode
LOCAL lcCaptureAmountAmount
LOCAL lcCaptureAmountCurrencyCode
LOCAL lcRefundedAmountAmount
LOCAL lcRefundedAmountCurrencyCode
LOCAL lcConvertedAmount
LOCAL lcConversionRate
LOCAL lcSoftDescriptor
LOCAL lcMerchantMetadata
LOCAL lcProviderMetadataProviderReferenceId
LOCAL lcStatusDetailsState
LOCAL lcStatusDetailsReasonCode
LOCAL lcStatusDetailsReasonDescription
LOCAL lcStatusDetailsLastUpdatedTimestamp
LOCAL lcCreationTimestamp
LOCAL lcExpirationTimestamp
LOCAL lcReleaseEnvironment

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = 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"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("cancellationReason","REASON DESCRIPTION")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.PrivateKey')
loPrivKey = CreateObject('Chilkat.PrivateKey')
lnSuccess = loPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
IF (lnSuccess = 0) THEN
    ? loPrivKey.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    CANCEL
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"
lnSuccess = loHttp.SetAuthPrivateKey(lcPublicKeyId,loPrivKey)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    CANCEL
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:
lnSuccess = loHttp.SetUrlVar("chargeId","bd504926-f659-4ad7-a1a9-9a747aaf5275")
* 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/charges/{$chargeId}/cancel",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

* 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
    CANCEL
ENDIF

RELEASE loResp

* 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 loSbResponseBody
RELEASE loJResp