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 <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkPrivateKey.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttp http;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkPrivateKey privKey;
const char *publicKeyId;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *paymentDescriptor;
const char *reasonCode;
const char *reasonDescription;
const char *chargePermissionId;
const char *chargePermissionReferenceId;
const char *buyerBuyerId;
const char *buyerName;
const char *buyerEmail;
const char *buyerPhoneNumber;
const char *buyerPrimeMembershipTypes;
const char *releaseEnvironment;
const char *shippingAddressName;
const char *shippingAddressAddressLine1;
const char *shippingAddressAddressLine2;
const char *shippingAddressAddressLine3;
const char *shippingAddressCity;
const char *shippingAddressCounty;
const char *shippingAddressDistrict;
const char *shippingAddressStateOrRegion;
const char *shippingAddressPostalCode;
const char *shippingAddressCountryCode;
const char *shippingAddressPhoneNumber;
const char *billingAddressName;
const char *billingAddressAddressLine1;
const char *billingAddressAddressLine2;
const char *billingAddressAddressLine3;
const char *billingAddressCity;
const char *billingAddressCounty;
const char *billingAddressDistrict;
const char *billingAddressStateOrRegion;
const char *billingAddressPostalCode;
const char *billingAddressCountryCode;
const char *billingAddressPhoneNumber;
const char *statusDetailsState;
const char *statusDetailsLastUpdatedTimestamp;
const char *creationTimestamp;
const char *expirationTimestamp;
const char *merchantMetadataMerchantReferenceId;
const char *merchantMetadataMerchantStoreName;
const char *merchantMetadataNoteToBuyer;
const char *merchantMetadataCustomInformation;
const char *platformId;
const char *limitsAmountLimitAmount;
const char *limitsAmountLimitCurrencyCode;
const char *limitsAmountBalanceAmount;
const char *limitsAmountBalanceCurrencyCode;
const char *presentmentCurrency;
int i;
int count_i;
success = FALSE;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// 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
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"closureReason","No more charges required");
CkJsonObject_UpdateBool(json,"cancelPendingCharges",FALSE);
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(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 = CkPrivateKey_Create();
success = CkPrivateKey_LoadPemFile(privKey,"C:/someDir/myAmazonPayPrivateKey.pem");
if (success == FALSE) {
printf("%s\n",CkPrivateKey_lastErrorText(privKey));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkPrivateKey_Dispose(privKey);
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
publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = CkHttp_SetAuthPrivateKey(http,publicKeyId,privKey);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkPrivateKey_Dispose(privKey);
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
CkHttp_putAccept(http,"application/json");
// Use the actual chargePermissionId here:
success = CkHttp_SetUrlVar(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 = CkHttpResponse_Create();
success = CkHttp_HttpSb(http,"DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",resp);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkPrivateKey_Dispose(privKey);
CkHttpResponse_Dispose(resp);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
// If the status code is not equal to 200, this will display error information.
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode != 200) {
printf("Failed.\n");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkPrivateKey_Dispose(privKey);
CkHttpResponse_Dispose(resp);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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.
chargePermissionId = CkJsonObject_stringOf(jResp,"chargePermissionId");
chargePermissionReferenceId = CkJsonObject_stringOf(jResp,"chargePermissionReferenceId");
buyerBuyerId = CkJsonObject_stringOf(jResp,"buyer.buyerId");
buyerName = CkJsonObject_stringOf(jResp,"buyer.name");
buyerEmail = CkJsonObject_stringOf(jResp,"buyer.email");
buyerPhoneNumber = CkJsonObject_stringOf(jResp,"buyer.phoneNumber");
buyerPrimeMembershipTypes = CkJsonObject_stringOf(jResp,"buyer.primeMembershipTypes");
releaseEnvironment = CkJsonObject_stringOf(jResp,"releaseEnvironment");
shippingAddressName = CkJsonObject_stringOf(jResp,"shippingAddress.name");
shippingAddressAddressLine1 = CkJsonObject_stringOf(jResp,"shippingAddress.addressLine1");
shippingAddressAddressLine2 = CkJsonObject_stringOf(jResp,"shippingAddress.addressLine2");
shippingAddressAddressLine3 = CkJsonObject_stringOf(jResp,"shippingAddress.addressLine3");
shippingAddressCity = CkJsonObject_stringOf(jResp,"shippingAddress.city");
shippingAddressCounty = CkJsonObject_stringOf(jResp,"shippingAddress.county");
shippingAddressDistrict = CkJsonObject_stringOf(jResp,"shippingAddress.district");
shippingAddressStateOrRegion = CkJsonObject_stringOf(jResp,"shippingAddress.stateOrRegion");
shippingAddressPostalCode = CkJsonObject_stringOf(jResp,"shippingAddress.postalCode");
shippingAddressCountryCode = CkJsonObject_stringOf(jResp,"shippingAddress.countryCode");
shippingAddressPhoneNumber = CkJsonObject_stringOf(jResp,"shippingAddress.phoneNumber");
billingAddressName = CkJsonObject_stringOf(jResp,"billingAddress.name");
billingAddressAddressLine1 = CkJsonObject_stringOf(jResp,"billingAddress.addressLine1");
billingAddressAddressLine2 = CkJsonObject_stringOf(jResp,"billingAddress.addressLine2");
billingAddressAddressLine3 = CkJsonObject_stringOf(jResp,"billingAddress.addressLine3");
billingAddressCity = CkJsonObject_stringOf(jResp,"billingAddress.city");
billingAddressCounty = CkJsonObject_stringOf(jResp,"billingAddress.county");
billingAddressDistrict = CkJsonObject_stringOf(jResp,"billingAddress.district");
billingAddressStateOrRegion = CkJsonObject_stringOf(jResp,"billingAddress.stateOrRegion");
billingAddressPostalCode = CkJsonObject_stringOf(jResp,"billingAddress.postalCode");
billingAddressCountryCode = CkJsonObject_stringOf(jResp,"billingAddress.countryCode");
billingAddressPhoneNumber = CkJsonObject_stringOf(jResp,"billingAddress.phoneNumber");
statusDetailsState = CkJsonObject_stringOf(jResp,"statusDetails.state");
statusDetailsLastUpdatedTimestamp = CkJsonObject_stringOf(jResp,"statusDetails.lastUpdatedTimestamp");
creationTimestamp = CkJsonObject_stringOf(jResp,"creationTimestamp");
expirationTimestamp = CkJsonObject_stringOf(jResp,"expirationTimestamp");
merchantMetadataMerchantReferenceId = CkJsonObject_stringOf(jResp,"merchantMetadata.merchantReferenceId");
merchantMetadataMerchantStoreName = CkJsonObject_stringOf(jResp,"merchantMetadata.merchantStoreName");
merchantMetadataNoteToBuyer = CkJsonObject_stringOf(jResp,"merchantMetadata.noteToBuyer");
merchantMetadataCustomInformation = CkJsonObject_stringOf(jResp,"merchantMetadata.customInformation");
platformId = CkJsonObject_stringOf(jResp,"platformId");
limitsAmountLimitAmount = CkJsonObject_stringOf(jResp,"limits.amountLimit.amount");
limitsAmountLimitCurrencyCode = CkJsonObject_stringOf(jResp,"limits.amountLimit.currencyCode");
limitsAmountBalanceAmount = CkJsonObject_stringOf(jResp,"limits.amountBalance.amount");
limitsAmountBalanceCurrencyCode = CkJsonObject_stringOf(jResp,"limits.amountBalance.currencyCode");
presentmentCurrency = CkJsonObject_stringOf(jResp,"presentmentCurrency");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"paymentPreferences");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
paymentDescriptor = CkJsonObject_stringOf(jResp,"paymentPreferences[i].paymentDescriptor");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"statusDetails.reasons");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
reasonCode = CkJsonObject_stringOf(jResp,"statusDetails.reasons[i].reasonCode");
reasonDescription = CkJsonObject_stringOf(jResp,"statusDetails.reasons[i].reasonDescription");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkPrivateKey_Dispose(privKey);
CkHttpResponse_Dispose(resp);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}