(Android™) 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 Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean 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
    // }

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

    CkStringBuilder sbRequestBody = new CkStringBuilder();
    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 = new CkPrivateKey();
    success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
    if (success == false) {
        Log.i(TAG, 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) {
        Log.i(TAG, 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.put_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
    CkHttpResponse resp = http.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);
    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    // If the status code is not equal to 200, this will display error information.
    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode != 200) {
        Log.i(TAG, "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.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;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}