(AutoIt) 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.

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

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

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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 = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("closureReason","No more charges required")
$oJson.UpdateBool("cancelPendingCharges",False)

$oSbRequestBody = ObjCreate("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 = ObjCreate("Chilkat.PrivateKey")
$bSuccess = $oPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If ($bSuccess = False) Then
    ConsoleWrite($oPrivKey.LastErrorText & @CRLF)
    Exit
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
Local $sPublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
$bSuccess = $oHttp.SetAuthPrivateKey($sPublicKeyId,$oPrivKey)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
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:
$bSuccess = $oHttp.SetUrlVar("chargePermissionId","P21-1111111-1111111")
; 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
Local $oResp = $oHttp.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

; If the status code is not equal to 200, this will display error information.
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode <> 200) Then
    ConsoleWrite("Failed." & @CRLF)

    Exit
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

Local $sPaymentDescriptor
Local $sReasonCode
Local $sReasonDescription

Local $sChargePermissionId = $oJResp.StringOf("chargePermissionId")
Local $sChargePermissionReferenceId = $oJResp.StringOf("chargePermissionReferenceId")
Local $sBuyerBuyerId = $oJResp.StringOf("buyer.buyerId")
Local $sBuyerName = $oJResp.StringOf("buyer.name")
Local $sBuyerEmail = $oJResp.StringOf("buyer.email")
Local $sBuyerPhoneNumber = $oJResp.StringOf("buyer.phoneNumber")
Local $sBuyerPrimeMembershipTypes = $oJResp.StringOf("buyer.primeMembershipTypes")
Local $sReleaseEnvironment = $oJResp.StringOf("releaseEnvironment")
Local $shippingAddressName = $oJResp.StringOf("shippingAddress.name")
Local $shippingAddressAddressLine1 = $oJResp.StringOf("shippingAddress.addressLine1")
Local $shippingAddressAddressLine2 = $oJResp.StringOf("shippingAddress.addressLine2")
Local $shippingAddressAddressLine3 = $oJResp.StringOf("shippingAddress.addressLine3")
Local $shippingAddressCity = $oJResp.StringOf("shippingAddress.city")
Local $shippingAddressCounty = $oJResp.StringOf("shippingAddress.county")
Local $shippingAddressDistrict = $oJResp.StringOf("shippingAddress.district")
Local $shippingAddressStateOrRegion = $oJResp.StringOf("shippingAddress.stateOrRegion")
Local $shippingAddressPostalCode = $oJResp.StringOf("shippingAddress.postalCode")
Local $shippingAddressCountryCode = $oJResp.StringOf("shippingAddress.countryCode")
Local $shippingAddressPhoneNumber = $oJResp.StringOf("shippingAddress.phoneNumber")
Local $sBillingAddressName = $oJResp.StringOf("billingAddress.name")
Local $sBillingAddressAddressLine1 = $oJResp.StringOf("billingAddress.addressLine1")
Local $sBillingAddressAddressLine2 = $oJResp.StringOf("billingAddress.addressLine2")
Local $sBillingAddressAddressLine3 = $oJResp.StringOf("billingAddress.addressLine3")
Local $sBillingAddressCity = $oJResp.StringOf("billingAddress.city")
Local $sBillingAddressCounty = $oJResp.StringOf("billingAddress.county")
Local $sBillingAddressDistrict = $oJResp.StringOf("billingAddress.district")
Local $sBillingAddressStateOrRegion = $oJResp.StringOf("billingAddress.stateOrRegion")
Local $sBillingAddressPostalCode = $oJResp.StringOf("billingAddress.postalCode")
Local $sBillingAddressCountryCode = $oJResp.StringOf("billingAddress.countryCode")
Local $sBillingAddressPhoneNumber = $oJResp.StringOf("billingAddress.phoneNumber")
Local $statusDetailsState = $oJResp.StringOf("statusDetails.state")
Local $statusDetailsLastUpdatedTimestamp = $oJResp.StringOf("statusDetails.lastUpdatedTimestamp")
Local $sCreationTimestamp = $oJResp.StringOf("creationTimestamp")
Local $sExpirationTimestamp = $oJResp.StringOf("expirationTimestamp")
Local $sMerchantMetadataMerchantReferenceId = $oJResp.StringOf("merchantMetadata.merchantReferenceId")
Local $sMerchantMetadataMerchantStoreName = $oJResp.StringOf("merchantMetadata.merchantStoreName")
Local $sMerchantMetadataNoteToBuyer = $oJResp.StringOf("merchantMetadata.noteToBuyer")
Local $sMerchantMetadataCustomInformation = $oJResp.StringOf("merchantMetadata.customInformation")
Local $sPlatformId = $oJResp.StringOf("platformId")
Local $sLimitsAmountLimitAmount = $oJResp.StringOf("limits.amountLimit.amount")
Local $sLimitsAmountLimitCurrencyCode = $oJResp.StringOf("limits.amountLimit.currencyCode")
Local $sLimitsAmountBalanceAmount = $oJResp.StringOf("limits.amountBalance.amount")
Local $sLimitsAmountBalanceCurrencyCode = $oJResp.StringOf("limits.amountBalance.currencyCode")
Local $sPresentmentCurrency = $oJResp.StringOf("presentmentCurrency")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("paymentPreferences")
While $i < $iCount_i
    $oJResp.I = $i
    $sPaymentDescriptor = $oJResp.StringOf("paymentPreferences[i].paymentDescriptor")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("statusDetails.reasons")
While $i < $iCount_i
    $oJResp.I = $i
    $sReasonCode = $oJResp.StringOf("statusDetails.reasons[i].reasonCode")
    $sReasonDescription = $oJResp.StringOf("statusDetails.reasons[i].reasonDescription")
    $i = $i + 1
Wend