(Chilkat2-Python) Amazon Pay - Update Charge Permission

See more Amazon Pay Examples

Update the Charge Permission with your external order metadata or the recurringMetadata.

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

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

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

http = chilkat2.Http()

# Implements the following CURL command:

# curl "https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId" \
# -X PATCH
# -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
# -H "x-amz-pay-date:20201012T235046Z"
# -d '{
#     "merchantMetadata": {
#         "merchantReferenceId": "32-41-323141-32",
#         "merchantStoreName": "AmazonTestStoreFront",
#         "noteToBuyer": "Some Note to buyer",
#         "customInformation": ""    
#      }  
# }'

# 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.

# {
#     "merchantMetadata": {
#         "merchantReferenceId": "32-41-323141-32",
#         "merchantStoreName": "AmazonTestStoreFront",
#         "noteToBuyer": "Some Note to buyer",
#         "customInformation": ""    
#      }  
# }

json = chilkat2.JsonObject()
json.UpdateString("merchantMetadata.merchantReferenceId","32-41-323141-32")
json.UpdateString("merchantMetadata.merchantStoreName","AmazonTestStoreFront")
json.UpdateString("merchantMetadata.noteToBuyer","Some Note to buyer")
json.UpdateString("merchantMetadata.customInformation","")

sbRequestBody = chilkat2.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.
privKey = chilkat2.PrivateKey()
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if (success == False):
    print(privKey.LastErrorText)
    sys.exit()

# 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):
    print(http.LastErrorText)
    sys.exit()

# 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"

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
# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode != 200):
    print("Failed.")

    sys.exit()

# 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": "Chargeable",
#         "reasons": 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")
statusDetailsReasons = jResp.StringOf("statusDetails.reasons")
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")
while i < count_i :
    jResp.I = i
    paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor")
    i = i + 1