Sample code for 30+ languages & platforms
Perl

Amazon Pay - Get Checkout Session

See more Amazon Pay Examples

Get Checkout Session details includes buyer info, payment instrument details, and shipping address.

Chilkat Perl Downloads

Download Chilkat for Perl
Perl 
use chilkat();

$success = 0;

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

$http = chilkat::CkHttp->new();

# 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.
$privKey = chilkat::CkPrivateKey->new();
$success = $privKey->LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if ($success == 0) {
    print $privKey->lastErrorText() . "\r\n";
    exit;
}

# 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 = $http->SetAuthPrivateKey($publicKeyId,$privKey);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

# 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");

$respStatusCode = 0;

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $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
$success = $http->QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",$sbResponseBody);
if ($success == 0) {
    # If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    $respStatusCode = $http->get_LastStatus();
    if ($respStatusCode != 0) {
        print "Response Status Code = " . $respStatusCode . "\r\n";
        # 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'"}

        print "Response body:" . "\r\n";
        print $http->lastResponseBody() . "\r\n";
    }
    else {
        print $http->lastErrorText() . "\r\n";
    }

    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
# We expect a 200 status code for success.
# Note: Some Amazon Pay API calls return 200 for success, others return 201.
if ($respStatusCode != 200) {
    print "Failed." . "\r\n";
    exit;
}

# 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

$checkoutSessionId = $jResp->stringOf("checkoutSessionId");
$webCheckoutDetailsCheckoutReviewReturnUrl = $jResp->stringOf("webCheckoutDetails.checkoutReviewReturnUrl");
$webCheckoutDetailsCheckoutResultReturnUrl = $jResp->stringOf("webCheckoutDetails.checkoutResultReturnUrl");
$webCheckoutDetailsCheckoutCancelUrl = $jResp->stringOf("webCheckoutDetails.checkoutCancelUrl");
$webCheckoutDetailsAmazonPayRedirectUrl = $jResp->stringOf("webCheckoutDetails.amazonPayRedirectUrl");
$chargePermissionType = $jResp->stringOf("chargePermissionType");
$recurringMetadataFrequencyUnit = $jResp->stringOf("recurringMetadata.frequency.unit");
$recurringMetadataFrequencyValue = $jResp->stringOf("recurringMetadata.frequency.value");
$recurringMetadataAmountAmount = $jResp->stringOf("recurringMetadata.amount.amount");
$recurringMetadataAmountCurrencyCode = $jResp->stringOf("recurringMetadata.amount.currencyCode");
$productType = $jResp->stringOf("productType");
$paymentDetailsPaymentIntent = $jResp->stringOf("paymentDetails.paymentIntent");
$paymentDetailsCanHandlePendingAuthorization = $jResp->BoolOf("paymentDetails.canHandlePendingAuthorization");
$paymentDetailsChargeAmount = $jResp->stringOf("paymentDetails.chargeAmount");
$paymentDetailsTotalOrderAmount = $jResp->stringOf("paymentDetails.totalOrderAmount");
$paymentDetailsSoftDescriptor = $jResp->stringOf("paymentDetails.softDescriptor");
$paymentDetailsPresentmentCurrency = $jResp->stringOf("paymentDetails.presentmentCurrency");
$paymentDetailsAllowOvercharge = $jResp->stringOf("paymentDetails.allowOvercharge");
$paymentDetailsExtendExpiration = $jResp->stringOf("paymentDetails.extendExpiration");
$merchantMetadataMerchantReferenceId = $jResp->stringOf("merchantMetadata.merchantReferenceId");
$merchantMetadataMerchantStoreName = $jResp->stringOf("merchantMetadata.merchantStoreName");
$merchantMetadataNoteToBuyer = $jResp->stringOf("merchantMetadata.noteToBuyer");
$merchantMetadataCustomInformation = $jResp->stringOf("merchantMetadata.customInformation");
$supplementaryData = $jResp->stringOf("supplementaryData");
$buyerBuyerId = $jResp->stringOf("buyer.buyerId");
$buyerName = $jResp->stringOf("buyer.name");
$buyerEmail = $jResp->stringOf("buyer.email");
$buyerPhoneNumber = $jResp->stringOf("buyer.phoneNumber");
$buyerPrimeMembershipTypes = $jResp->stringOf("buyer.primeMembershipTypes");
$billingAddressName = $jResp->stringOf("billingAddress.name");
$billingAddressAddressLine1 = $jResp->stringOf("billingAddress.addressLine1");
$billingAddressAddressLine2 = $jResp->stringOf("billingAddress.addressLine2");
$billingAddressAddressLine3 = $jResp->stringOf("billingAddress.addressLine3");
$billingAddressCity = $jResp->stringOf("billingAddress.city");
$billingAddressCounty = $jResp->stringOf("billingAddress.county");
$billingAddressDistrict = $jResp->stringOf("billingAddress.district");
$billingAddressStateOrRegion = $jResp->stringOf("billingAddress.stateOrRegion");
$billingAddressPostalCode = $jResp->stringOf("billingAddress.postalCode");
$billingAddressCountryCode = $jResp->stringOf("billingAddress.countryCode");
$statusDetailsState = $jResp->stringOf("statusDetails.state");
$statusDetailsReasonCode = $jResp->stringOf("statusDetails.reasonCode");
$statusDetailsReasonDescription = $jResp->stringOf("statusDetails.reasonDescription");
$statusDetailsLastUpdatedTimestamp = $jResp->stringOf("statusDetails.lastUpdatedTimestamp");
$shippingAddressName = $jResp->stringOf("shippingAddress.name");
$shippingAddressAddressLine1 = $jResp->stringOf("shippingAddress.addressLine1");
$shippingAddressAddressLine2 = $jResp->stringOf("shippingAddress.addressLine2");
$shippingAddressAddressLine3 = $jResp->stringOf("shippingAddress.addressLine3");
$shippingAddressCity = $jResp->stringOf("shippingAddress.city");
$shippingAddressCounty = $jResp->stringOf("shippingAddress.county");
$shippingAddressDistrict = $jResp->stringOf("shippingAddress.district");
$shippingAddressStateOrRegion = $jResp->stringOf("shippingAddress.stateOrRegion");
$shippingAddressPostalCode = $jResp->stringOf("shippingAddress.postalCode");
$shippingAddressCountryCode = $jResp->stringOf("shippingAddress.countryCode");
$shippingAddressPhoneNumber = $jResp->stringOf("shippingAddress.phoneNumber");
$platformId = $jResp->stringOf("platformId");
$chargePermissionId = $jResp->stringOf("chargePermissionId");
$chargeId = $jResp->stringOf("chargeId");
$creationTimestamp = $jResp->stringOf("creationTimestamp");
$expirationTimestamp = $jResp->stringOf("expirationTimestamp");
$storeId = $jResp->stringOf("storeId");
$deliverySpecificationsAddressRestrictionsType = $jResp->stringOf("deliverySpecifications.addressRestrictions.type");
$providerMetadataProviderReferenceId = $jResp->stringOf("providerMetadata.providerReferenceId");
$releaseEnvironment = $jResp->stringOf("releaseEnvironment");
$i = 0;
$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("constraints");
while ($i < $count_i) {
    $jResp->put_I($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->put_I($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->put_I($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->put_I($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->put_I($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->put_I($i);
    $strVal = $jResp->stringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]");
    $i = $i + 1;
}