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

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_PrivKey
string ls_PublicKeyId
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_PaymentDescriptor
string ls_ChargePermissionId
string ls_ChargePermissionReferenceId
string ls_BuyerBuyerId
string ls_BuyerName
string ls_BuyerEmail
string ls_BuyerPhoneNumber
string ls_BuyerPrimeMembershipTypes
string ls_ReleaseEnvironment
string ls_ShippingAddressName
string ls_ShippingAddressAddressLine1
string ls_ShippingAddressAddressLine2
string ls_ShippingAddressAddressLine3
string ls_ShippingAddressCity
string ls_ShippingAddressCounty
string ls_ShippingAddressDistrict
string ls_ShippingAddressStateOrRegion
string ls_ShippingAddressPostalCode
string ls_ShippingAddressCountryCode
string ls_ShippingAddressPhoneNumber
string ls_BillingAddressName
string ls_BillingAddressAddressLine1
string ls_BillingAddressAddressLine2
string ls_BillingAddressAddressLine3
string ls_BillingAddressCity
string ls_BillingAddressCounty
string ls_BillingAddressDistrict
string ls_BillingAddressStateOrRegion
string ls_BillingAddressPostalCode
string ls_BillingAddressCountryCode
string ls_BillingAddressPhoneNumber
string ls_StatusDetailsState
string ls_StatusDetailsReasons
string ls_StatusDetailsLastUpdatedTimestamp
string ls_CreationTimestamp
string ls_ExpirationTimestamp
string ls_MerchantMetadataMerchantReferenceId
string ls_MerchantMetadataMerchantStoreName
string ls_MerchantMetadataNoteToBuyer
string ls_MerchantMetadataCustomInformation
string ls_PlatformId
string ls_LimitsAmountLimitAmount
string ls_LimitsAmountLimitCurrencyCode
string ls_LimitsAmountBalanceAmount
string ls_LimitsAmountBalanceCurrencyCode
string ls_PresentmentCurrency
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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": ""    
//      }  
// }

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

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

loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_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.
loo_PrivKey = create oleobject
// Use "Chilkat_9_5_0.PrivateKey" for versions of Chilkat < 10.0.0
li_rc = loo_PrivKey.ConnectToNewObject("Chilkat.PrivateKey")

li_Success = loo_PrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if li_Success = 0 then
    Write-Debug loo_PrivKey.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_PrivKey
    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
ls_PublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
li_Success = loo_Http.SetAuthPrivateKey(ls_PublicKeyId,loo_PrivKey)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_PrivKey
    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

loo_Http.Accept = "application/json"

li_Success = loo_Http.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
loo_Resp = loo_Http.PTextSb("PATCH","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_PrivKey
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

// If the status code is not equal to 200, this will display error information.
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode <> 200 then
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_PrivKey
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

// 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

ls_ChargePermissionId = loo_JResp.StringOf("chargePermissionId")
ls_ChargePermissionReferenceId = loo_JResp.StringOf("chargePermissionReferenceId")
ls_BuyerBuyerId = loo_JResp.StringOf("buyer.buyerId")
ls_BuyerName = loo_JResp.StringOf("buyer.name")
ls_BuyerEmail = loo_JResp.StringOf("buyer.email")
ls_BuyerPhoneNumber = loo_JResp.StringOf("buyer.phoneNumber")
ls_BuyerPrimeMembershipTypes = loo_JResp.StringOf("buyer.primeMembershipTypes")
ls_ReleaseEnvironment = loo_JResp.StringOf("releaseEnvironment")
ls_ShippingAddressName = loo_JResp.StringOf("shippingAddress.name")
ls_ShippingAddressAddressLine1 = loo_JResp.StringOf("shippingAddress.addressLine1")
ls_ShippingAddressAddressLine2 = loo_JResp.StringOf("shippingAddress.addressLine2")
ls_ShippingAddressAddressLine3 = loo_JResp.StringOf("shippingAddress.addressLine3")
ls_ShippingAddressCity = loo_JResp.StringOf("shippingAddress.city")
ls_ShippingAddressCounty = loo_JResp.StringOf("shippingAddress.county")
ls_ShippingAddressDistrict = loo_JResp.StringOf("shippingAddress.district")
ls_ShippingAddressStateOrRegion = loo_JResp.StringOf("shippingAddress.stateOrRegion")
ls_ShippingAddressPostalCode = loo_JResp.StringOf("shippingAddress.postalCode")
ls_ShippingAddressCountryCode = loo_JResp.StringOf("shippingAddress.countryCode")
ls_ShippingAddressPhoneNumber = loo_JResp.StringOf("shippingAddress.phoneNumber")
ls_BillingAddressName = loo_JResp.StringOf("billingAddress.name")
ls_BillingAddressAddressLine1 = loo_JResp.StringOf("billingAddress.addressLine1")
ls_BillingAddressAddressLine2 = loo_JResp.StringOf("billingAddress.addressLine2")
ls_BillingAddressAddressLine3 = loo_JResp.StringOf("billingAddress.addressLine3")
ls_BillingAddressCity = loo_JResp.StringOf("billingAddress.city")
ls_BillingAddressCounty = loo_JResp.StringOf("billingAddress.county")
ls_BillingAddressDistrict = loo_JResp.StringOf("billingAddress.district")
ls_BillingAddressStateOrRegion = loo_JResp.StringOf("billingAddress.stateOrRegion")
ls_BillingAddressPostalCode = loo_JResp.StringOf("billingAddress.postalCode")
ls_BillingAddressCountryCode = loo_JResp.StringOf("billingAddress.countryCode")
ls_BillingAddressPhoneNumber = loo_JResp.StringOf("billingAddress.phoneNumber")
ls_StatusDetailsState = loo_JResp.StringOf("statusDetails.state")
ls_StatusDetailsReasons = loo_JResp.StringOf("statusDetails.reasons")
ls_StatusDetailsLastUpdatedTimestamp = loo_JResp.StringOf("statusDetails.lastUpdatedTimestamp")
ls_CreationTimestamp = loo_JResp.StringOf("creationTimestamp")
ls_ExpirationTimestamp = loo_JResp.StringOf("expirationTimestamp")
ls_MerchantMetadataMerchantReferenceId = loo_JResp.StringOf("merchantMetadata.merchantReferenceId")
ls_MerchantMetadataMerchantStoreName = loo_JResp.StringOf("merchantMetadata.merchantStoreName")
ls_MerchantMetadataNoteToBuyer = loo_JResp.StringOf("merchantMetadata.noteToBuyer")
ls_MerchantMetadataCustomInformation = loo_JResp.StringOf("merchantMetadata.customInformation")
ls_PlatformId = loo_JResp.StringOf("platformId")
ls_LimitsAmountLimitAmount = loo_JResp.StringOf("limits.amountLimit.amount")
ls_LimitsAmountLimitCurrencyCode = loo_JResp.StringOf("limits.amountLimit.currencyCode")
ls_LimitsAmountBalanceAmount = loo_JResp.StringOf("limits.amountBalance.amount")
ls_LimitsAmountBalanceCurrencyCode = loo_JResp.StringOf("limits.amountBalance.currencyCode")
ls_PresentmentCurrency = loo_JResp.StringOf("presentmentCurrency")
i = 0
li_Count_i = loo_JResp.SizeOfArray("paymentPreferences")
do while i < li_Count_i
    loo_JResp.I = i
    ls_PaymentDescriptor = loo_JResp.StringOf("paymentPreferences[i].paymentDescriptor")
    i = i + 1
loop


destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_PrivKey
destroy loo_SbResponseBody
destroy loo_JResp