(PHP ActiveX) Amazon Pay - Create Checkout Session

See more Amazon Pay Examples

Create a new Amazon Pay Checkout Session.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#create-checkout-session

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Implements the following CURL command:

// curl "https://pay-api.amazon.com/:version/checkoutSessions/" \
// -X POST
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
// -d '{
//     "webCheckoutDetails": {
//         "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
//     },
//     "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
//     "scopes": ["name", "email", "phoneNumber", "billingAddress"],
//     "deliverySpecifications": {
//         "specialRestrictions": ["RestrictPOBoxes"],
//         "addressRestrictions": {
//             "type": "Allowed",
//             "restrictions": {
//                 "US": {
//                     "statesOrRegions": ["WA"],
//                     "zipCodes": ["95050", "93405"]
//                 },
//                 "GB": {
//                     "zipCodes": ["72046", "72047"]
//                 },
//                 "IN": {
//                     "statesOrRegions": ["AP"]
//                 },
//                 "JP": {}
//             }
//         }
//     }
// }'

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

// {
//   "webCheckoutDetails": {
//     "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
//   },
//   "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
//   "scopes": [
//     "name",
//     "email",
//     "phoneNumber",
//     "billingAddress"
//   ],
//   "deliverySpecifications": {
//     "specialRestrictions": [
//       "RestrictPOBoxes"
//     ],
//     "addressRestrictions": {
//       "type": "Allowed",
//       "restrictions": {
//         "US": {
//           "statesOrRegions": [
//             "WA"
//           ],
//           "zipCodes": [
//             "95050",
//             "93405"
//           ]
//         },
//         "GB": {
//           "zipCodes": [
//             "72046",
//             "72047"
//           ]
//         },
//         "IN": {
//           "statesOrRegions": [
//             "AP"
//           ]
//         },
//         "JP": {}
//       }
//     }
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('webCheckoutDetails.checkoutReviewReturnUrl','https://a.com/merchant-review-page');
// Make sure to use your storeId here:
$json->UpdateString('storeId','amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId');
$i = 0;
$json->I = $i;
$json->UpdateString('scopes[i]','name');
$i = $i + 1;
$json->I = $i;
$json->UpdateString('scopes[i]','email');
$i = $i + 1;
$json->I = $i;
$json->UpdateString('scopes[i]','phoneNumber');
$i = $i + 1;
$json->I = $i;
$json->UpdateString('scopes[i]','billingAddress');
$json->UpdateString('deliverySpecifications.specialRestrictions[0]','RestrictPOBoxes');
$json->UpdateString('deliverySpecifications.addressRestrictions.type','Allowed');
$json->UpdateString('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]','WA');
$json->UpdateString('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]','95050');
$json->UpdateString('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]','93405');
$json->UpdateString('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]','72046');
$json->UpdateString('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]','72047');
$json->UpdateString('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]','AP');
$json->UpdateNewObject('deliverySpecifications.addressRestrictions.restrictions.JP');

// 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.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.PrivateKey')
$privKey = new COM("Chilkat.PrivateKey");
$success = $privKey->LoadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
if ($success == 0) {
    print $privKey->LastErrorText . "\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 . "\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
// x-amz-pay-idempotency-key
// Authorization

$http->Accept = 'application/json';

// To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

// If the status code is not equal to 201, this will display error information.
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 201) {

    // The jResp would've contained an error message, similar to this:
    // 	{
    // 	  "reasonCode": "InvalidHeaderValue",
    // 	  "message": "The value AF2EGWREIPHV2S2TUFFBRDGM provided for PublicKeyId is invalid. Please verify that you are using the PublicKeyId in the correct region and environment."
    // 	}

    print 'Failed.' . "\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
//   },
//   "productType": "PayAndShip",
//   "chargePermissionType": "Recurring",
//   "recurringMetadata": {
//     "frequency": {
//       "unit": "Month",
//       "value": "1"
//     },
//     "amount": {
//       "amount": "30",
//       "currencyCode": "USD"
//     }
//   },
//   "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": null,
//   "billingAddress": null,
//   "paymentPreferences": [
//     null
//   ],
//   "statusDetails": {
//     "state": "Open",
//     "reasonCode": null,
//     "reasonDescription": null,
//     "lastUpdatedTimestamp": "20191015T204327Z"
//   },
//   "shippingAddress": null,
//   "platformId": null,
//   "chargePermissionId": null,
//   "chargeId": null,
//   "constraints": [
//     {
//       "constraintId": "BuyerNotAssociated",
//       "description": "There is no buyer associated with the Checkout Session. Return the checkout session id to the Amazon Pay Button to allow buyer to login."
//     },
//     {
//       "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');
$productType = $jResp->stringOf('productType');
$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');
$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');
$buyer = $jResp->stringOf('buyer');
$billingAddress = $jResp->stringOf('billingAddress');
$statusDetailsState = $jResp->stringOf('statusDetails.state');
$statusDetailsReasonCode = $jResp->stringOf('statusDetails.reasonCode');
$statusDetailsReasonDescription = $jResp->stringOf('statusDetails.reasonDescription');
$statusDetailsLastUpdatedTimestamp = $jResp->stringOf('statusDetails.lastUpdatedTimestamp');
$shippingAddress = $jResp->stringOf('shippingAddress');
$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->I = $i;
    $nullVal = $jResp->IsNullOf('paymentPreferences[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('constraints');
while ($i < $count_i) {
    $jResp->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->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->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->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->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->I = $i;
    $strVal = $jResp->stringOf('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]');
    $i = $i + 1;
}


?>