(Visual FoxPro) 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

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

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loPrivKey
LOCAL lcPublicKeyId
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcPaymentDescriptor
LOCAL lcChargePermissionId
LOCAL lcChargePermissionReferenceId
LOCAL lcBuyerBuyerId
LOCAL lcBuyerName
LOCAL lcBuyerEmail
LOCAL lcBuyerPhoneNumber
LOCAL lcBuyerPrimeMembershipTypes
LOCAL lcReleaseEnvironment
LOCAL lcShippingAddressName
LOCAL lcShippingAddressAddressLine1
LOCAL lcShippingAddressAddressLine2
LOCAL lcShippingAddressAddressLine3
LOCAL lcShippingAddressCity
LOCAL lcShippingAddressCounty
LOCAL lcShippingAddressDistrict
LOCAL lcShippingAddressStateOrRegion
LOCAL lcShippingAddressPostalCode
LOCAL lcShippingAddressCountryCode
LOCAL lcShippingAddressPhoneNumber
LOCAL lcBillingAddressName
LOCAL lcBillingAddressAddressLine1
LOCAL lcBillingAddressAddressLine2
LOCAL lcBillingAddressAddressLine3
LOCAL lcBillingAddressCity
LOCAL lcBillingAddressCounty
LOCAL lcBillingAddressDistrict
LOCAL lcBillingAddressStateOrRegion
LOCAL lcBillingAddressPostalCode
LOCAL lcBillingAddressCountryCode
LOCAL lcBillingAddressPhoneNumber
LOCAL lcStatusDetailsState
LOCAL lcStatusDetailsReasons
LOCAL lcStatusDetailsLastUpdatedTimestamp
LOCAL lcCreationTimestamp
LOCAL lcExpirationTimestamp
LOCAL lcMerchantMetadataMerchantReferenceId
LOCAL lcMerchantMetadataMerchantStoreName
LOCAL lcMerchantMetadataNoteToBuyer
LOCAL lcMerchantMetadataCustomInformation
LOCAL lcPlatformId
LOCAL lcLimitsAmountLimitAmount
LOCAL lcLimitsAmountLimitCurrencyCode
LOCAL lcLimitsAmountBalanceAmount
LOCAL lcLimitsAmountBalanceCurrencyCode
LOCAL lcPresentmentCurrency
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.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": ""    
*      }  
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("merchantMetadata.merchantReferenceId","32-41-323141-32")
loJson.UpdateString("merchantMetadata.merchantStoreName","AmazonTestStoreFront")
loJson.UpdateString("merchantMetadata.noteToBuyer","Some Note to buyer")
loJson.UpdateString("merchantMetadata.customInformation","")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.PrivateKey')
loPrivKey = CreateObject('Chilkat.PrivateKey')
lnSuccess = loPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
IF (lnSuccess = 0) THEN
    ? loPrivKey.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    CANCEL
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
lcPublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
lnSuccess = loHttp.SetAuthPrivateKey(lcPublicKeyId,loPrivKey)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    CANCEL
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

loHttp.Accept = "application/json"

lnSuccess = loHttp.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
loResp = loHttp.PTextSb("PATCH","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

* If the status code is not equal to 200, this will display error information.
? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode <> 200) THEN
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loPrivKey
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcChargePermissionId = loJResp.StringOf("chargePermissionId")
lcChargePermissionReferenceId = loJResp.StringOf("chargePermissionReferenceId")
lcBuyerBuyerId = loJResp.StringOf("buyer.buyerId")
lcBuyerName = loJResp.StringOf("buyer.name")
lcBuyerEmail = loJResp.StringOf("buyer.email")
lcBuyerPhoneNumber = loJResp.StringOf("buyer.phoneNumber")
lcBuyerPrimeMembershipTypes = loJResp.StringOf("buyer.primeMembershipTypes")
lcReleaseEnvironment = loJResp.StringOf("releaseEnvironment")
lcShippingAddressName = loJResp.StringOf("shippingAddress.name")
lcShippingAddressAddressLine1 = loJResp.StringOf("shippingAddress.addressLine1")
lcShippingAddressAddressLine2 = loJResp.StringOf("shippingAddress.addressLine2")
lcShippingAddressAddressLine3 = loJResp.StringOf("shippingAddress.addressLine3")
lcShippingAddressCity = loJResp.StringOf("shippingAddress.city")
lcShippingAddressCounty = loJResp.StringOf("shippingAddress.county")
lcShippingAddressDistrict = loJResp.StringOf("shippingAddress.district")
lcShippingAddressStateOrRegion = loJResp.StringOf("shippingAddress.stateOrRegion")
lcShippingAddressPostalCode = loJResp.StringOf("shippingAddress.postalCode")
lcShippingAddressCountryCode = loJResp.StringOf("shippingAddress.countryCode")
lcShippingAddressPhoneNumber = loJResp.StringOf("shippingAddress.phoneNumber")
lcBillingAddressName = loJResp.StringOf("billingAddress.name")
lcBillingAddressAddressLine1 = loJResp.StringOf("billingAddress.addressLine1")
lcBillingAddressAddressLine2 = loJResp.StringOf("billingAddress.addressLine2")
lcBillingAddressAddressLine3 = loJResp.StringOf("billingAddress.addressLine3")
lcBillingAddressCity = loJResp.StringOf("billingAddress.city")
lcBillingAddressCounty = loJResp.StringOf("billingAddress.county")
lcBillingAddressDistrict = loJResp.StringOf("billingAddress.district")
lcBillingAddressStateOrRegion = loJResp.StringOf("billingAddress.stateOrRegion")
lcBillingAddressPostalCode = loJResp.StringOf("billingAddress.postalCode")
lcBillingAddressCountryCode = loJResp.StringOf("billingAddress.countryCode")
lcBillingAddressPhoneNumber = loJResp.StringOf("billingAddress.phoneNumber")
lcStatusDetailsState = loJResp.StringOf("statusDetails.state")
lcStatusDetailsReasons = loJResp.StringOf("statusDetails.reasons")
lcStatusDetailsLastUpdatedTimestamp = loJResp.StringOf("statusDetails.lastUpdatedTimestamp")
lcCreationTimestamp = loJResp.StringOf("creationTimestamp")
lcExpirationTimestamp = loJResp.StringOf("expirationTimestamp")
lcMerchantMetadataMerchantReferenceId = loJResp.StringOf("merchantMetadata.merchantReferenceId")
lcMerchantMetadataMerchantStoreName = loJResp.StringOf("merchantMetadata.merchantStoreName")
lcMerchantMetadataNoteToBuyer = loJResp.StringOf("merchantMetadata.noteToBuyer")
lcMerchantMetadataCustomInformation = loJResp.StringOf("merchantMetadata.customInformation")
lcPlatformId = loJResp.StringOf("platformId")
lcLimitsAmountLimitAmount = loJResp.StringOf("limits.amountLimit.amount")
lcLimitsAmountLimitCurrencyCode = loJResp.StringOf("limits.amountLimit.currencyCode")
lcLimitsAmountBalanceAmount = loJResp.StringOf("limits.amountBalance.amount")
lcLimitsAmountBalanceCurrencyCode = loJResp.StringOf("limits.amountBalance.currencyCode")
lcPresentmentCurrency = loJResp.StringOf("presentmentCurrency")
i = 0
lnCount_i = loJResp.SizeOfArray("paymentPreferences")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcPaymentDescriptor = loJResp.StringOf("paymentPreferences[i].paymentDescriptor")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loPrivKey
RELEASE loSbResponseBody
RELEASE loJResp