VB.NET
VB.NET
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.Chilkat VB.NET Downloads
Dim success As Boolean = False
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
' 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
json.UpdateString("closureReason","No more charges required")
json.UpdateBool("cancelPendingCharges",False)
Dim sbRequestBody As New Chilkat.StringBuilder
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
Debug.WriteLine(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
Dim publicKeyId As String = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
If (success = False) Then
Debug.WriteLine(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","P21-1111111-1111111")
' 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
Dim resp As New Chilkat.HttpResponse
success = http.HttpSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",resp)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
' If the status code is not equal to 200, this will display error information.
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode <> 200) Then
Debug.WriteLine("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
Dim paymentDescriptor As String
Dim reasonCode As String
Dim reasonDescription As String
Dim chargePermissionId As String = jResp.StringOf("chargePermissionId")
Dim chargePermissionReferenceId As String = jResp.StringOf("chargePermissionReferenceId")
Dim buyerBuyerId As String = jResp.StringOf("buyer.buyerId")
Dim buyerName As String = jResp.StringOf("buyer.name")
Dim buyerEmail As String = jResp.StringOf("buyer.email")
Dim buyerPhoneNumber As String = jResp.StringOf("buyer.phoneNumber")
Dim buyerPrimeMembershipTypes As String = jResp.StringOf("buyer.primeMembershipTypes")
Dim releaseEnvironment As String = jResp.StringOf("releaseEnvironment")
Dim shippingAddressName As String = jResp.StringOf("shippingAddress.name")
Dim shippingAddressAddressLine1 As String = jResp.StringOf("shippingAddress.addressLine1")
Dim shippingAddressAddressLine2 As String = jResp.StringOf("shippingAddress.addressLine2")
Dim shippingAddressAddressLine3 As String = jResp.StringOf("shippingAddress.addressLine3")
Dim shippingAddressCity As String = jResp.StringOf("shippingAddress.city")
Dim shippingAddressCounty As String = jResp.StringOf("shippingAddress.county")
Dim shippingAddressDistrict As String = jResp.StringOf("shippingAddress.district")
Dim shippingAddressStateOrRegion As String = jResp.StringOf("shippingAddress.stateOrRegion")
Dim shippingAddressPostalCode As String = jResp.StringOf("shippingAddress.postalCode")
Dim shippingAddressCountryCode As String = jResp.StringOf("shippingAddress.countryCode")
Dim shippingAddressPhoneNumber As String = jResp.StringOf("shippingAddress.phoneNumber")
Dim billingAddressName As String = jResp.StringOf("billingAddress.name")
Dim billingAddressAddressLine1 As String = jResp.StringOf("billingAddress.addressLine1")
Dim billingAddressAddressLine2 As String = jResp.StringOf("billingAddress.addressLine2")
Dim billingAddressAddressLine3 As String = jResp.StringOf("billingAddress.addressLine3")
Dim billingAddressCity As String = jResp.StringOf("billingAddress.city")
Dim billingAddressCounty As String = jResp.StringOf("billingAddress.county")
Dim billingAddressDistrict As String = jResp.StringOf("billingAddress.district")
Dim billingAddressStateOrRegion As String = jResp.StringOf("billingAddress.stateOrRegion")
Dim billingAddressPostalCode As String = jResp.StringOf("billingAddress.postalCode")
Dim billingAddressCountryCode As String = jResp.StringOf("billingAddress.countryCode")
Dim billingAddressPhoneNumber As String = jResp.StringOf("billingAddress.phoneNumber")
Dim statusDetailsState As String = jResp.StringOf("statusDetails.state")
Dim statusDetailsLastUpdatedTimestamp As String = jResp.StringOf("statusDetails.lastUpdatedTimestamp")
Dim creationTimestamp As String = jResp.StringOf("creationTimestamp")
Dim expirationTimestamp As String = jResp.StringOf("expirationTimestamp")
Dim merchantMetadataMerchantReferenceId As String = jResp.StringOf("merchantMetadata.merchantReferenceId")
Dim merchantMetadataMerchantStoreName As String = jResp.StringOf("merchantMetadata.merchantStoreName")
Dim merchantMetadataNoteToBuyer As String = jResp.StringOf("merchantMetadata.noteToBuyer")
Dim merchantMetadataCustomInformation As String = jResp.StringOf("merchantMetadata.customInformation")
Dim platformId As String = jResp.StringOf("platformId")
Dim limitsAmountLimitAmount As String = jResp.StringOf("limits.amountLimit.amount")
Dim limitsAmountLimitCurrencyCode As String = jResp.StringOf("limits.amountLimit.currencyCode")
Dim limitsAmountBalanceAmount As String = jResp.StringOf("limits.amountBalance.amount")
Dim limitsAmountBalanceCurrencyCode As String = jResp.StringOf("limits.amountBalance.currencyCode")
Dim presentmentCurrency As String = jResp.StringOf("presentmentCurrency")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("paymentPreferences")
While i < count_i
jResp.I = i
paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor")
i = i + 1
End While
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
End While