PureBasic
PureBasic
Amazon Pay - Update Charge Permission
See more Amazon Pay Examples
Update the Charge Permission with your external order metadata or the recurringMetadata.Chilkat PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPrivateKey.pb"
Procedure ChilkatExample()
success.i = 0
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"merchantMetadata.merchantReferenceId","32-41-323141-32")
CkJsonObject::ckUpdateString(json,"merchantMetadata.merchantStoreName","AmazonTestStoreFront")
CkJsonObject::ckUpdateString(json,"merchantMetadata.noteToBuyer","Some Note to buyer")
CkJsonObject::ckUpdateString(json,"merchantMetadata.customInformation","")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,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.i = CkPrivateKey::ckCreate()
If privKey.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkPrivateKey::ckLoadPemFile(privKey,"C:/someDir/myAmazonPayPrivateKey.pem")
If success = 0
Debug CkPrivateKey::ckLastErrorText(privKey)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
ProcedureReturn
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
publicKeyId.s = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = CkHttp::ckSetAuthPrivateKey(http,publicKeyId,privKey)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
ProcedureReturn
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
CkHttp::setCkAccept(http, "application/json")
success = CkHttp::ckSetUrlVar(http,"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
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpSb(http,"PATCH","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}",sbRequestBody,"utf-8","application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
; If the status code is not equal to 200, this will display error information.
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
paymentDescriptor.s
chargePermissionId.s = CkJsonObject::ckStringOf(jResp,"chargePermissionId")
chargePermissionReferenceId.s = CkJsonObject::ckStringOf(jResp,"chargePermissionReferenceId")
buyerBuyerId.s = CkJsonObject::ckStringOf(jResp,"buyer.buyerId")
buyerName.s = CkJsonObject::ckStringOf(jResp,"buyer.name")
buyerEmail.s = CkJsonObject::ckStringOf(jResp,"buyer.email")
buyerPhoneNumber.s = CkJsonObject::ckStringOf(jResp,"buyer.phoneNumber")
buyerPrimeMembershipTypes.s = CkJsonObject::ckStringOf(jResp,"buyer.primeMembershipTypes")
releaseEnvironment.s = CkJsonObject::ckStringOf(jResp,"releaseEnvironment")
shippingAddressName.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.name")
shippingAddressAddressLine1.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.addressLine1")
shippingAddressAddressLine2.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.addressLine2")
shippingAddressAddressLine3.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.addressLine3")
shippingAddressCity.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.city")
shippingAddressCounty.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.county")
shippingAddressDistrict.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.district")
shippingAddressStateOrRegion.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.stateOrRegion")
shippingAddressPostalCode.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.postalCode")
shippingAddressCountryCode.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.countryCode")
shippingAddressPhoneNumber.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.phoneNumber")
billingAddressName.s = CkJsonObject::ckStringOf(jResp,"billingAddress.name")
billingAddressAddressLine1.s = CkJsonObject::ckStringOf(jResp,"billingAddress.addressLine1")
billingAddressAddressLine2.s = CkJsonObject::ckStringOf(jResp,"billingAddress.addressLine2")
billingAddressAddressLine3.s = CkJsonObject::ckStringOf(jResp,"billingAddress.addressLine3")
billingAddressCity.s = CkJsonObject::ckStringOf(jResp,"billingAddress.city")
billingAddressCounty.s = CkJsonObject::ckStringOf(jResp,"billingAddress.county")
billingAddressDistrict.s = CkJsonObject::ckStringOf(jResp,"billingAddress.district")
billingAddressStateOrRegion.s = CkJsonObject::ckStringOf(jResp,"billingAddress.stateOrRegion")
billingAddressPostalCode.s = CkJsonObject::ckStringOf(jResp,"billingAddress.postalCode")
billingAddressCountryCode.s = CkJsonObject::ckStringOf(jResp,"billingAddress.countryCode")
billingAddressPhoneNumber.s = CkJsonObject::ckStringOf(jResp,"billingAddress.phoneNumber")
statusDetailsState.s = CkJsonObject::ckStringOf(jResp,"statusDetails.state")
statusDetailsReasons.s = CkJsonObject::ckStringOf(jResp,"statusDetails.reasons")
statusDetailsLastUpdatedTimestamp.s = CkJsonObject::ckStringOf(jResp,"statusDetails.lastUpdatedTimestamp")
creationTimestamp.s = CkJsonObject::ckStringOf(jResp,"creationTimestamp")
expirationTimestamp.s = CkJsonObject::ckStringOf(jResp,"expirationTimestamp")
merchantMetadataMerchantReferenceId.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.merchantReferenceId")
merchantMetadataMerchantStoreName.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.merchantStoreName")
merchantMetadataNoteToBuyer.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.noteToBuyer")
merchantMetadataCustomInformation.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.customInformation")
platformId.s = CkJsonObject::ckStringOf(jResp,"platformId")
limitsAmountLimitAmount.s = CkJsonObject::ckStringOf(jResp,"limits.amountLimit.amount")
limitsAmountLimitCurrencyCode.s = CkJsonObject::ckStringOf(jResp,"limits.amountLimit.currencyCode")
limitsAmountBalanceAmount.s = CkJsonObject::ckStringOf(jResp,"limits.amountBalance.amount")
limitsAmountBalanceCurrencyCode.s = CkJsonObject::ckStringOf(jResp,"limits.amountBalance.currencyCode")
presentmentCurrency.s = CkJsonObject::ckStringOf(jResp,"presentmentCurrency")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"paymentPreferences")
While i < count_i
CkJsonObject::setCkI(jResp, i)
paymentDescriptor = CkJsonObject::ckStringOf(jResp,"paymentPreferences[i].paymentDescriptor")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure