(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http
Dim success As Boolean

// 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 New Chilkat.JsonObject
success = json.UpdateString("closureReason","No more charges required")
success = json.UpdateBool("cancelPendingCharges",False)

Dim sbRequestBody As New Chilkat.StringBuilder
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 New Chilkat.PrivateKey
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If (success = False) Then
    System.DebugLog(privKey.LastErrorText)
    Return
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
Dim publicKeyId As String
publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
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
Dim resp As Chilkat.HttpResponse
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
    System.DebugLog(http.LastErrorText)
    Return
End If

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

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

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
    System.DebugLog("Failed.")

    Return
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

Dim paymentDescriptor As String
Dim reasonCode As String
Dim reasonDescription As String

Dim chargePermissionId As String
chargePermissionId = jResp.StringOf("chargePermissionId")
Dim chargePermissionReferenceId As String
chargePermissionReferenceId = jResp.StringOf("chargePermissionReferenceId")
Dim buyerBuyerId As String
buyerBuyerId = jResp.StringOf("buyer.buyerId")
Dim buyerName As String
buyerName = jResp.StringOf("buyer.name")
Dim buyerEmail As String
buyerEmail = jResp.StringOf("buyer.email")
Dim buyerPhoneNumber As String
buyerPhoneNumber = jResp.StringOf("buyer.phoneNumber")
Dim buyerPrimeMembershipTypes As String
buyerPrimeMembershipTypes = jResp.StringOf("buyer.primeMembershipTypes")
Dim releaseEnvironment As String
releaseEnvironment = jResp.StringOf("releaseEnvironment")
Dim shippingAddressName As String
shippingAddressName = jResp.StringOf("shippingAddress.name")
Dim shippingAddressAddressLine1 As String
shippingAddressAddressLine1 = jResp.StringOf("shippingAddress.addressLine1")
Dim shippingAddressAddressLine2 As String
shippingAddressAddressLine2 = jResp.StringOf("shippingAddress.addressLine2")
Dim shippingAddressAddressLine3 As String
shippingAddressAddressLine3 = jResp.StringOf("shippingAddress.addressLine3")
Dim shippingAddressCity As String
shippingAddressCity = jResp.StringOf("shippingAddress.city")
Dim shippingAddressCounty As String
shippingAddressCounty = jResp.StringOf("shippingAddress.county")
Dim shippingAddressDistrict As String
shippingAddressDistrict = jResp.StringOf("shippingAddress.district")
Dim shippingAddressStateOrRegion As String
shippingAddressStateOrRegion = jResp.StringOf("shippingAddress.stateOrRegion")
Dim shippingAddressPostalCode As String
shippingAddressPostalCode = jResp.StringOf("shippingAddress.postalCode")
Dim shippingAddressCountryCode As String
shippingAddressCountryCode = jResp.StringOf("shippingAddress.countryCode")
Dim shippingAddressPhoneNumber As String
shippingAddressPhoneNumber = jResp.StringOf("shippingAddress.phoneNumber")
Dim billingAddressName As String
billingAddressName = jResp.StringOf("billingAddress.name")
Dim billingAddressAddressLine1 As String
billingAddressAddressLine1 = jResp.StringOf("billingAddress.addressLine1")
Dim billingAddressAddressLine2 As String
billingAddressAddressLine2 = jResp.StringOf("billingAddress.addressLine2")
Dim billingAddressAddressLine3 As String
billingAddressAddressLine3 = jResp.StringOf("billingAddress.addressLine3")
Dim billingAddressCity As String
billingAddressCity = jResp.StringOf("billingAddress.city")
Dim billingAddressCounty As String
billingAddressCounty = jResp.StringOf("billingAddress.county")
Dim billingAddressDistrict As String
billingAddressDistrict = jResp.StringOf("billingAddress.district")
Dim billingAddressStateOrRegion As String
billingAddressStateOrRegion = jResp.StringOf("billingAddress.stateOrRegion")
Dim billingAddressPostalCode As String
billingAddressPostalCode = jResp.StringOf("billingAddress.postalCode")
Dim billingAddressCountryCode As String
billingAddressCountryCode = jResp.StringOf("billingAddress.countryCode")
Dim billingAddressPhoneNumber As String
billingAddressPhoneNumber = jResp.StringOf("billingAddress.phoneNumber")
Dim statusDetailsState As String
statusDetailsState = jResp.StringOf("statusDetails.state")
Dim statusDetailsLastUpdatedTimestamp As String
statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp")
Dim creationTimestamp As String
creationTimestamp = jResp.StringOf("creationTimestamp")
Dim expirationTimestamp As String
expirationTimestamp = jResp.StringOf("expirationTimestamp")
Dim merchantMetadataMerchantReferenceId As String
merchantMetadataMerchantReferenceId = jResp.StringOf("merchantMetadata.merchantReferenceId")
Dim merchantMetadataMerchantStoreName As String
merchantMetadataMerchantStoreName = jResp.StringOf("merchantMetadata.merchantStoreName")
Dim merchantMetadataNoteToBuyer As String
merchantMetadataNoteToBuyer = jResp.StringOf("merchantMetadata.noteToBuyer")
Dim merchantMetadataCustomInformation As String
merchantMetadataCustomInformation = jResp.StringOf("merchantMetadata.customInformation")
Dim platformId As String
platformId = jResp.StringOf("platformId")
Dim limitsAmountLimitAmount As String
limitsAmountLimitAmount = jResp.StringOf("limits.amountLimit.amount")
Dim limitsAmountLimitCurrencyCode As String
limitsAmountLimitCurrencyCode = jResp.StringOf("limits.amountLimit.currencyCode")
Dim limitsAmountBalanceAmount As String
limitsAmountBalanceAmount = jResp.StringOf("limits.amountBalance.amount")
Dim limitsAmountBalanceCurrencyCode As String
limitsAmountBalanceCurrencyCode = jResp.StringOf("limits.amountBalance.currencyCode")
Dim presentmentCurrency As String
presentmentCurrency = jResp.StringOf("presentmentCurrency")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("paymentPreferences")
While i < count_i
    jResp.I = i
    paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("statusDetails.reasons")
While i < count_i
    jResp.I = i
    reasonCode = jResp.StringOf("statusDetails.reasons[i].reasonCode")
    reasonDescription = jResp.StringOf("statusDetails.reasons[i].reasonDescription")
    i = i + 1
Wend