(Mono 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.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#close-charge-permission

Chilkat .NET Downloads Chilkat .NET Assemblies Chilkat for .NET Core Chilkat for Mono

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("closureReason","No more charges required");
json.UpdateBool("cancelPendingCharges",false);

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
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.
Chilkat.PrivateKey privKey = new Chilkat.PrivateKey();
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if (success == false) {
    Debug.WriteLine(privKey.LastErrorText);
    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
string publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = http.SetAuthPrivateKey(publicKeyId,privKey);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    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.Accept = "application/json";

// Use the actual chargePermissionId here:
success = http.SetUrlVar("chargePermissionId","CHARGE_PERMISSION_ID");
// 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
Chilkat.HttpResponse resp = http.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

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

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode != 200) {
    Debug.WriteLine("Failed.");

    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

string paymentDescriptor;
string reasonCode;
string reasonDescription;

string chargePermissionId = jResp.StringOf("chargePermissionId");
string chargePermissionReferenceId = jResp.StringOf("chargePermissionReferenceId");
string buyerBuyerId = jResp.StringOf("buyer.buyerId");
string buyerName = jResp.StringOf("buyer.name");
string buyerEmail = jResp.StringOf("buyer.email");
string buyerPhoneNumber = jResp.StringOf("buyer.phoneNumber");
string buyerPrimeMembershipTypes = jResp.StringOf("buyer.primeMembershipTypes");
string releaseEnvironment = jResp.StringOf("releaseEnvironment");
string shippingAddressName = jResp.StringOf("shippingAddress.name");
string shippingAddressAddressLine1 = jResp.StringOf("shippingAddress.addressLine1");
string shippingAddressAddressLine2 = jResp.StringOf("shippingAddress.addressLine2");
string shippingAddressAddressLine3 = jResp.StringOf("shippingAddress.addressLine3");
string shippingAddressCity = jResp.StringOf("shippingAddress.city");
string shippingAddressCounty = jResp.StringOf("shippingAddress.county");
string shippingAddressDistrict = jResp.StringOf("shippingAddress.district");
string shippingAddressStateOrRegion = jResp.StringOf("shippingAddress.stateOrRegion");
string shippingAddressPostalCode = jResp.StringOf("shippingAddress.postalCode");
string shippingAddressCountryCode = jResp.StringOf("shippingAddress.countryCode");
string shippingAddressPhoneNumber = jResp.StringOf("shippingAddress.phoneNumber");
string billingAddressName = jResp.StringOf("billingAddress.name");
string billingAddressAddressLine1 = jResp.StringOf("billingAddress.addressLine1");
string billingAddressAddressLine2 = jResp.StringOf("billingAddress.addressLine2");
string billingAddressAddressLine3 = jResp.StringOf("billingAddress.addressLine3");
string billingAddressCity = jResp.StringOf("billingAddress.city");
string billingAddressCounty = jResp.StringOf("billingAddress.county");
string billingAddressDistrict = jResp.StringOf("billingAddress.district");
string billingAddressStateOrRegion = jResp.StringOf("billingAddress.stateOrRegion");
string billingAddressPostalCode = jResp.StringOf("billingAddress.postalCode");
string billingAddressCountryCode = jResp.StringOf("billingAddress.countryCode");
string billingAddressPhoneNumber = jResp.StringOf("billingAddress.phoneNumber");
string statusDetailsState = jResp.StringOf("statusDetails.state");
string statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp");
string creationTimestamp = jResp.StringOf("creationTimestamp");
string expirationTimestamp = jResp.StringOf("expirationTimestamp");
string merchantMetadataMerchantReferenceId = jResp.StringOf("merchantMetadata.merchantReferenceId");
string merchantMetadataMerchantStoreName = jResp.StringOf("merchantMetadata.merchantStoreName");
string merchantMetadataNoteToBuyer = jResp.StringOf("merchantMetadata.noteToBuyer");
string merchantMetadataCustomInformation = jResp.StringOf("merchantMetadata.customInformation");
string platformId = jResp.StringOf("platformId");
string limitsAmountLimitAmount = jResp.StringOf("limits.amountLimit.amount");
string limitsAmountLimitCurrencyCode = jResp.StringOf("limits.amountLimit.currencyCode");
string limitsAmountBalanceAmount = jResp.StringOf("limits.amountBalance.amount");
string limitsAmountBalanceCurrencyCode = jResp.StringOf("limits.amountBalance.currencyCode");
string presentmentCurrency = jResp.StringOf("presentmentCurrency");
int i = 0;
int count_i = jResp.SizeOfArray("paymentPreferences");
while (i < count_i) {
    jResp.I = i;
    paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("statusDetails.reasons");
while (i < count_i) {
    jResp.I = i;
    reasonCode = jResp.StringOf("statusDetails.reasons[i].reasonCode");
    reasonDescription = jResp.StringOf("statusDetails.reasons[i].reasonDescription");
    i = i + 1;
}