C++
C++
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 C++ Downloads
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkPrivateKey.h>
#include <CkHttpResponse.h>
void ChilkatSample(void)
{
bool success = false;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp 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
// }
CkJsonObject json;
json.UpdateString("closureReason","No more charges required");
json.UpdateBool("cancelPendingCharges",false);
CkStringBuilder sbRequestBody;
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.
CkPrivateKey privKey;
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if (success == false) {
std::cout << privKey.lastErrorText() << "\r\n";
return;
}
// 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
const char *publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = http.SetAuthPrivateKey(publicKeyId,privKey);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
// 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.put_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
CkHttpResponse resp;
success = http.HttpSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",resp);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
// If the status code is not equal to 200, this will display error information.
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp.get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode != 200) {
std::cout << "Failed." << "\r\n";
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
// See this example explaining how this memory should be used: const char * functions.
const char *paymentDescriptor = 0;
const char *reasonCode = 0;
const char *reasonDescription = 0;
const char *chargePermissionId = jResp.stringOf("chargePermissionId");
const char *chargePermissionReferenceId = jResp.stringOf("chargePermissionReferenceId");
const char *buyerBuyerId = jResp.stringOf("buyer.buyerId");
const char *buyerName = jResp.stringOf("buyer.name");
const char *buyerEmail = jResp.stringOf("buyer.email");
const char *buyerPhoneNumber = jResp.stringOf("buyer.phoneNumber");
const char *buyerPrimeMembershipTypes = jResp.stringOf("buyer.primeMembershipTypes");
const char *releaseEnvironment = jResp.stringOf("releaseEnvironment");
const char *shippingAddressName = jResp.stringOf("shippingAddress.name");
const char *shippingAddressAddressLine1 = jResp.stringOf("shippingAddress.addressLine1");
const char *shippingAddressAddressLine2 = jResp.stringOf("shippingAddress.addressLine2");
const char *shippingAddressAddressLine3 = jResp.stringOf("shippingAddress.addressLine3");
const char *shippingAddressCity = jResp.stringOf("shippingAddress.city");
const char *shippingAddressCounty = jResp.stringOf("shippingAddress.county");
const char *shippingAddressDistrict = jResp.stringOf("shippingAddress.district");
const char *shippingAddressStateOrRegion = jResp.stringOf("shippingAddress.stateOrRegion");
const char *shippingAddressPostalCode = jResp.stringOf("shippingAddress.postalCode");
const char *shippingAddressCountryCode = jResp.stringOf("shippingAddress.countryCode");
const char *shippingAddressPhoneNumber = jResp.stringOf("shippingAddress.phoneNumber");
const char *billingAddressName = jResp.stringOf("billingAddress.name");
const char *billingAddressAddressLine1 = jResp.stringOf("billingAddress.addressLine1");
const char *billingAddressAddressLine2 = jResp.stringOf("billingAddress.addressLine2");
const char *billingAddressAddressLine3 = jResp.stringOf("billingAddress.addressLine3");
const char *billingAddressCity = jResp.stringOf("billingAddress.city");
const char *billingAddressCounty = jResp.stringOf("billingAddress.county");
const char *billingAddressDistrict = jResp.stringOf("billingAddress.district");
const char *billingAddressStateOrRegion = jResp.stringOf("billingAddress.stateOrRegion");
const char *billingAddressPostalCode = jResp.stringOf("billingAddress.postalCode");
const char *billingAddressCountryCode = jResp.stringOf("billingAddress.countryCode");
const char *billingAddressPhoneNumber = jResp.stringOf("billingAddress.phoneNumber");
const char *statusDetailsState = jResp.stringOf("statusDetails.state");
const char *statusDetailsLastUpdatedTimestamp = jResp.stringOf("statusDetails.lastUpdatedTimestamp");
const char *creationTimestamp = jResp.stringOf("creationTimestamp");
const char *expirationTimestamp = jResp.stringOf("expirationTimestamp");
const char *merchantMetadataMerchantReferenceId = jResp.stringOf("merchantMetadata.merchantReferenceId");
const char *merchantMetadataMerchantStoreName = jResp.stringOf("merchantMetadata.merchantStoreName");
const char *merchantMetadataNoteToBuyer = jResp.stringOf("merchantMetadata.noteToBuyer");
const char *merchantMetadataCustomInformation = jResp.stringOf("merchantMetadata.customInformation");
const char *platformId = jResp.stringOf("platformId");
const char *limitsAmountLimitAmount = jResp.stringOf("limits.amountLimit.amount");
const char *limitsAmountLimitCurrencyCode = jResp.stringOf("limits.amountLimit.currencyCode");
const char *limitsAmountBalanceAmount = jResp.stringOf("limits.amountBalance.amount");
const char *limitsAmountBalanceCurrencyCode = jResp.stringOf("limits.amountBalance.currencyCode");
const char *presentmentCurrency = jResp.stringOf("presentmentCurrency");
int i = 0;
int count_i = jResp.SizeOfArray("paymentPreferences");
while (i < count_i) {
jResp.put_I(i);
paymentDescriptor = jResp.stringOf("paymentPreferences[i].paymentDescriptor");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("statusDetails.reasons");
while (i < count_i) {
jResp.put_I(i);
reasonCode = jResp.stringOf("statusDetails.reasons[i].reasonCode");
reasonDescription = jResp.stringOf("statusDetails.reasons[i].reasonDescription");
i = i + 1;
}
}