Java Requires Chilkat v11.0.0+
Chilkat2 Java
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 Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.PrivateKey;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Http http = new 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
// }
JsonObject json = new JsonObject();
json.updateString("closureReason", "No more charges required");
json.updateBool("cancelPendingCharges", false);
StringBuilder sbRequestBody = new 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.
PrivateKey privKey = new PrivateKey();
try {
privKey.loadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
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";
try {
http.setAuthPrivateKey(publicKeyId, privKey);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
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.setAccept("application/json");
// Use the actual chargePermissionId here:
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
HttpResponse resp = new HttpResponse();
try {
http.httpSb("DELETE", "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close", sbRequestBody, "utf-8", "application/json", resp);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
StringBuilder sbResponseBody = new StringBuilder();
resp.getBodySb(sbResponseBody);
JsonObject jResp = new JsonObject();
jResp.loadSb(sbResponseBody);
jResp.setEmitCompact(false);
// If the status code is not equal to 200, this will display error information.
System.out.println("Response Body:");
System.out.println(jResp.emit());
int respStatusCode = resp.getStatusCode();
System.out.println("Response Status Code = " + respStatusCode);
if (respStatusCode != 200) {
System.out.println("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.setI(i);
paymentDescriptor = jResp.stringOf("paymentPreferences[i].paymentDescriptor");
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("statusDetails.reasons");
while (i < count_i) {
jResp.setI(i);
reasonCode = jResp.stringOf("statusDetails.reasons[i].reasonCode");
reasonDescription = jResp.stringOf("statusDetails.reasons[i].reasonDescription");
i = i + 1;
}
}
}