Java
Chilkat2 Java
Amazon Pay - Get Checkout Session
See more Amazon Pay Examples
Get Checkout Session details includes buyer info, payment instrument details, and shipping address.Chilkat Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
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/checkoutSessions/:checkoutSessionId"
// -X GET
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code
// 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");
int respStatusCode = 0;
StringBuilder sbResponseBody = new StringBuilder();
http.setUrlVar("sessionId", "62b7d028-6c7c-4a43-b077-3897dff27c5b");
// To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
try {
http.quickGetSb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}", sbResponseBody);
} catch (ChilkatException e) {
// If the LastStatus is not equal to 0, then we received a response, but it was an error response.
respStatusCode = http.getLastStatus();
if (respStatusCode != 0) {
System.out.println("Response Status Code = " + respStatusCode);
// A sample response body for the case where the session ID does not exist:
// {"reasonCode":"ResourceNotFound","message":"Resource you are trying to access is not available. Requested path '/sandbox/v2/checkoutSessions/bd504926-f659-4ad7-a1a9-9a747aaf5275'"}
System.out.println("Response body:");
System.out.println(http.getLastResponseBody());
} else {
System.out.println(e.getLastErrorText());
}
return;
}
JsonObject jResp = new JsonObject();
jResp.loadSb(sbResponseBody);
jResp.setEmitCompact(false);
System.out.println("Response Body:");
System.out.println(jResp.emit());
respStatusCode = http.getLastStatus();
System.out.println("Response Status Code = " + respStatusCode);
// We expect a 200 status code for success.
// Note: Some Amazon Pay API calls return 200 for success, others return 201.
if (respStatusCode != 200) {
System.out.println("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
// "checkoutResultReturnUrl": null,
// "checkoutCancelUrl": null,
// "amazonPayRedirectUrl": null
// },
// "chargePermissionType": "Recurring",
// "recurringMetadata": {
// "frequency": {
// "unit": "Month",
// "value": "1"
// },
// "amount": {
// "amount": "30",
// "currencyCode": "USD"
// }
// },
// "productType": "PayAndShip",
// "paymentDetails": {
// "paymentIntent": null,
// "canHandlePendingAuthorization": false,
// "chargeAmount": null,
// "totalOrderAmount": null,
// "softDescriptor": null,
// "presentmentCurrency": null,
// "allowOvercharge": null,
// "extendExpiration": null
// },
// "merchantMetadata": {
// "merchantReferenceId": null,
// "merchantStoreName": null,
// "noteToBuyer": null,
// "customInformation": null
// },
// "supplementaryData": null,
// "buyer": {
// "buyerId": "buyerId",
// "name": "name-1",
// "email": "name@amazon.com",
// "phoneNumber": "800-000-0000",
// "primeMembershipTypes": null
// },
// "billingAddress": {
// "name": "Work",
// "addressLine1": "440 Terry Ave",
// "addressLine2": "",
// "addressLine3": "",
// "city": "Seattle",
// "county": "King",
// "district": "Seattle",
// "stateOrRegion": "WA",
// "postalCode": "98121",
// "countryCode": "US"
// },
// "paymentPreferences": [
// {
// "paymentDescriptor": "Your selected Amazon payment method"
// }
// ],
// "statusDetails": {
// "state": "Open",
// "reasonCode": null,
// "reasonDescription": null,
// "lastUpdatedTimestamp": "20191015T204327Z"
// },
// "shippingAddress": {
// "name": "Susie Smith",
// "addressLine1": "10 Ditka Ave",
// "addressLine2": "Suite 2500",
// "addressLine3": null,
// "city": "Chicago",
// "county": null,
// "district": null,
// "stateOrRegion": "IL",
// "postalCode": "60602",
// "countryCode": "US",
// "phoneNumber": "800-000-0000"
// },
// "platformId": null,
// "chargePermissionId": null,
// "chargeId": null,
// "constraints": [
// {
// "constraintId": "ChargeAmountNotSet",
// "description": "chargeAmount is not set."
// },
// {
// "constraintId": "CheckoutResultReturnUrlNotSet",
// "description": "checkoutResultReturnUrl is not set."
// },
// {
// "constraintId": "PaymentIntentNotSet",
// "description": "paymentIntent is not set."
// }
// ],
// "creationTimestamp": "20191015T204313Z",
// "expirationTimestamp": "20191016T204313Z",
// "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
// "deliverySpecifications": {
// "specialRestrictions": [
// "RestrictPOBoxes"
// ],
// "addressRestrictions": {
// "type": "Allowed",
// "restrictions": {
// "US": {
// "statesOrRegions": [
// "WA"
// ],
// "zipCodes": [
// "95050",
// "93405"
// ]
// },
// "GB": {
// "zipCodes": [
// "72046",
// "72047"
// ]
// },
// "IN": {
// "statesOrRegions": [
// "AP"
// ]
// },
// "JP": {}
// }
// }
// },
// "providerMetadata": {
// "providerReferenceId": null
// },
// "releaseEnvironment": "Sandbox"
// }
// 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 constraintId = "";
String description = "";
String strVal = "";
String checkoutSessionId = jResp.stringOf("checkoutSessionId");
String webCheckoutDetailsCheckoutReviewReturnUrl = jResp.stringOf("webCheckoutDetails.checkoutReviewReturnUrl");
String webCheckoutDetailsCheckoutResultReturnUrl = jResp.stringOf("webCheckoutDetails.checkoutResultReturnUrl");
String webCheckoutDetailsCheckoutCancelUrl = jResp.stringOf("webCheckoutDetails.checkoutCancelUrl");
String webCheckoutDetailsAmazonPayRedirectUrl = jResp.stringOf("webCheckoutDetails.amazonPayRedirectUrl");
String chargePermissionType = jResp.stringOf("chargePermissionType");
String recurringMetadataFrequencyUnit = jResp.stringOf("recurringMetadata.frequency.unit");
String recurringMetadataFrequencyValue = jResp.stringOf("recurringMetadata.frequency.value");
String recurringMetadataAmountAmount = jResp.stringOf("recurringMetadata.amount.amount");
String recurringMetadataAmountCurrencyCode = jResp.stringOf("recurringMetadata.amount.currencyCode");
String productType = jResp.stringOf("productType");
String paymentDetailsPaymentIntent = jResp.stringOf("paymentDetails.paymentIntent");
boolean paymentDetailsCanHandlePendingAuthorization = jResp.boolOf("paymentDetails.canHandlePendingAuthorization");
String paymentDetailsChargeAmount = jResp.stringOf("paymentDetails.chargeAmount");
String paymentDetailsTotalOrderAmount = jResp.stringOf("paymentDetails.totalOrderAmount");
String paymentDetailsSoftDescriptor = jResp.stringOf("paymentDetails.softDescriptor");
String paymentDetailsPresentmentCurrency = jResp.stringOf("paymentDetails.presentmentCurrency");
String paymentDetailsAllowOvercharge = jResp.stringOf("paymentDetails.allowOvercharge");
String paymentDetailsExtendExpiration = jResp.stringOf("paymentDetails.extendExpiration");
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 supplementaryData = jResp.stringOf("supplementaryData");
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 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 statusDetailsState = jResp.stringOf("statusDetails.state");
String statusDetailsReasonCode = jResp.stringOf("statusDetails.reasonCode");
String statusDetailsReasonDescription = jResp.stringOf("statusDetails.reasonDescription");
String statusDetailsLastUpdatedTimestamp = jResp.stringOf("statusDetails.lastUpdatedTimestamp");
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 platformId = jResp.stringOf("platformId");
String chargePermissionId = jResp.stringOf("chargePermissionId");
String chargeId = jResp.stringOf("chargeId");
String creationTimestamp = jResp.stringOf("creationTimestamp");
String expirationTimestamp = jResp.stringOf("expirationTimestamp");
String storeId = jResp.stringOf("storeId");
String deliverySpecificationsAddressRestrictionsType = jResp.stringOf("deliverySpecifications.addressRestrictions.type");
String providerMetadataProviderReferenceId = jResp.stringOf("providerMetadata.providerReferenceId");
String releaseEnvironment = jResp.stringOf("releaseEnvironment");
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("constraints");
while (i < count_i) {
jResp.setI(i);
constraintId = jResp.stringOf("constraints[i].constraintId");
description = jResp.stringOf("constraints[i].description");
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("deliverySpecifications.specialRestrictions");
while (i < count_i) {
jResp.setI(i);
strVal = jResp.stringOf("deliverySpecifications.specialRestrictions[i]");
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions");
while (i < count_i) {
jResp.setI(i);
strVal = jResp.stringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]");
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes");
while (i < count_i) {
jResp.setI(i);
strVal = jResp.stringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]");
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes");
while (i < count_i) {
jResp.setI(i);
strVal = jResp.stringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]");
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions");
while (i < count_i) {
jResp.setI(i);
strVal = jResp.stringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]");
i = i + 1;
}
}
}