(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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
' }

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.UpdateString("closureReason","No more charges required")
success = json.UpdateBool("cancelPendingCharges",False)

Dim sbRequestBody As Chilkat.StringBuilder
Set sbRequestBody = Chilkat.NewStringBuilder
success = json.EmitSb(sbRequestBody)

' 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.
Dim privKey As Chilkat.PrivateKey
Set privKey = Chilkat.NewPrivateKey
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If (success = False) Then
    Debug.Print privKey.LastErrorText
    Exit Sub
End If

' 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

publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' 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

http.Accept = "application/json"

' Use the actual chargePermissionId here:
success = http.SetUrlVar("chargePermissionId","CHARGE_PERMISSION_ID")
' 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

Set resp = http.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

' If the status code is not equal to 200, this will display error information.
Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode <> 200) Then
    Debug.Print "Failed."

    Exit Sub
End If

' 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


chargePermissionId = jResp.StringOf("chargePermissionId")

chargePermissionReferenceId = jResp.StringOf("chargePermissionReferenceId")

buyerBuyerId = jResp.StringOf("buyer.buyerId")

buyerName = jResp.StringOf("buyer.name")

buyerEmail = jResp.StringOf("buyer.email")

buyerPhoneNumber = jResp.StringOf("buyer.phoneNumber")

buyerPrimeMembershipTypes = jResp.StringOf("buyer.primeMembershipTypes")

releaseEnvironment = jResp.StringOf("releaseEnvironment")

shippingAddressName = jResp.StringOf("shippingAddress.name")

shippingAddressAddressLine1 = jResp.StringOf("shippingAddress.addressLine1")

shippingAddressAddressLine2 = jResp.StringOf("shippingAddress.addressLine2")

shippingAddressAddressLine3 = jResp.StringOf("shippingAddress.addressLine3")

shippingAddressCity = jResp.StringOf("shippingAddress.city")

shippingAddressCounty = jResp.StringOf("shippingAddress.county")

shippingAddressDistrict = jResp.StringOf("shippingAddress.district")

shippingAddressStateOrRegion = jResp.StringOf("shippingAddress.stateOrRegion")

shippingAddressPostalCode = jResp.StringOf("shippingAddress.postalCode")

shippingAddressCountryCode = jResp.StringOf("shippingAddress.countryCode")

shippingAddressPhoneNumber = jResp.StringOf("shippingAddress.phoneNumber")

billingAddressName = jResp.StringOf("billingAddress.name")

billingAddressAddressLine1 = jResp.StringOf("billingAddress.addressLine1")

billingAddressAddressLine2 = jResp.StringOf("billingAddress.addressLine2")

billingAddressAddressLine3 = jResp.StringOf("billingAddress.addressLine3")

billingAddressCity = jResp.StringOf("billingAddress.city")

billingAddressCounty = jResp.StringOf("billingAddress.county")

billingAddressDistrict = jResp.StringOf("billingAddress.district")

billingAddressStateOrRegion = jResp.StringOf("billingAddress.stateOrRegion")

billingAddressPostalCode = jResp.StringOf("billingAddress.postalCode")

billingAddressCountryCode = jResp.StringOf("billingAddress.countryCode")

billingAddressPhoneNumber = jResp.StringOf("billingAddress.phoneNumber")

statusDetailsState = jResp.StringOf("statusDetails.state")

statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp")

creationTimestamp = jResp.StringOf("creationTimestamp")

expirationTimestamp = jResp.StringOf("expirationTimestamp")

merchantMetadataMerchantReferenceId = jResp.StringOf("merchantMetadata.merchantReferenceId")

merchantMetadataMerchantStoreName = jResp.StringOf("merchantMetadata.merchantStoreName")

merchantMetadataNoteToBuyer = jResp.StringOf("merchantMetadata.noteToBuyer")

merchantMetadataCustomInformation = jResp.StringOf("merchantMetadata.customInformation")

platformId = jResp.StringOf("platformId")

limitsAmountLimitAmount = jResp.StringOf("limits.amountLimit.amount")

limitsAmountLimitCurrencyCode = jResp.StringOf("limits.amountLimit.currencyCode")

limitsAmountBalanceAmount = jResp.StringOf("limits.amountBalance.amount")

limitsAmountBalanceCurrencyCode = jResp.StringOf("limits.amountBalance.currencyCode")

presentmentCurrency = jResp.StringOf("presentmentCurrency")

i = 0

count_i = jResp.SizeOfArray("paymentPreferences")
Do While i < count_i
    jResp.I = i
    paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("statusDetails.reasons")
Do While i < count_i
    jResp.I = i
    reasonCode = jResp.StringOf("statusDetails.reasons[i].reasonCode")
    reasonDescription = jResp.StringOf("statusDetails.reasons[i].reasonDescription")
    i = i + 1
Loop