Download the PHP package amzn/amazon-pay-api-sdk-php without Composer

Amazon Pay API SDK (PHP)

Amazon Pay Integration

Please note that the Amazon Pay API SDK can only be used for API calls to the pay-api.amazon.com|eu|jp endpoint.

If you need to make an Amazon Pay API call that uses the mws.amazonservices.com|jp or mws-eu.amazonservices.com endpoint, then you will need to use the original Amazon Pay SDK (PHP).

Requirements

• PHP 5.6.1 or higher, but highly recommended to use only the latest PHP version, and update often, to ensure current security fixes are applied
• Curl 7.18 or higher
• phpseclib 3.0

SDK Installation

Use composer to install the latest release of the SDK and its dependencies:

Verify the installation with the following test script:

Public and Private Keys

MWS access keys, MWS secret keys, and MWS authorization tokens from previous MWS integrations cannot be used with this SDK.

You will need to generate your own public/private key pair to make API calls with this SDK.

In Windows 10 this can be done with ssh-keygen commands:

In Linux or macOS this can be done using openssl commands:

The first command above generates a private key and the second line uses the private key to generate a public key.

To associate the key with your account, follow the instructions here to Get your Public Key ID.

Namespace

Namespace for this package is Amazon\Pay\API so that there are no conflicts with the original Amazon Pay MWS SDK's that use the AmazonPay namespace.

Configuration Array

If you have created environment specific keys (i.e Public Key Starts with LIVE or SANDBOX) in Seller Central, then use those PublicKeyId & PrivateKey. In this case, there is no need to pass the Sandbox parameter to the ApiConfiguration.

If you have want to enable proxy support, you can set it in the $amazonpay_config in the following way:

Versioning

The pay-api.amazon.com|eu|jp endpoint uses versioning to allow future updates. The major version of this SDK will stay aligned with the API version of the endpoint.

If you have downloaded version 1.x.y of this SDK, $version in below examples would be "v1". 2.x.y would be "v2", etc.

Convenience Functions (Overview)

Make use of the built-in convenience functions to easily make API calls. Scroll down further to see example code snippets.

When using the convenience functions, the request payload will be signed using the provided private key, and a HTTPS request is made to the correct regional endpoint. In the event of request throttling, the HTTPS call will be attempted up to three times using an exponential backoff approach.

Alexa Delivery Trackers API

Use this API to provide shipment tracking information to Amazon Pay so that Amazon Pay can notify buyers on Alexa when shipments are out for delivery and when they are delivered. Please refer to the Delivery Trackers API documentation for additional information.

• deliveryTrackers($payload, $headers = null) → POST to "$version/deliveryTrackers"

Authorization Tokens API

Please note that your solution provider account must have a pre-existing relationship (valid and active MWS authorization token) with the merchant account in order to use this function.

• getAuthorizationToken($mwsAuthToken, $merchantId, $headers = null) → GET to "$version/authorizationTokens/$mwsAuthToken?merchantId=$merchantId"

Amazon Checkout v2 API

API Integration Guide

The $headers field is not optional for create/POST calls below because it requires, at a minimum, the x-amz-pay-idempotency-key header:

Amazon Checkout v2 Buyer object

• getBuyer($buyerToken, $headers = null) → GET to "$version/buyers/$buyerToken"

Amazon Checkout v2 CheckoutSession object

• createCheckoutSession($payload, $headers) → POST to "$version/checkoutSessions"
• getCheckoutSession($checkoutSessionId, $headers = null) → GET to "$version/checkoutSessions/$checkoutSessionId"
• updateCheckoutSession($checkoutSessionId, $payload, $headers = null) → PATCH to "$version/checkoutSessions/$checkoutSessionId"
• completeCheckoutSession($checkoutSessionId, $payload, $headers = null) → POST to "$version/checkoutSessions/$checkoutSessionId/complete"

Amazon Checkout v2 ChargePermission object

• getChargePermission($chargePermissionId, $headers = null) → GET to "$version/chargePermissions/$chargePermissionId"
• updateChargePermission($chargePermissionId, $payload, $headers = null) → PATCH to "$version/chargePermissions/$chargePermissionId"
• closeChargePermission($chargePermissionId, $payload, $headers = null) → DELETE to "$version/chargePermissions/$chargePermissionId/close"

Amazon Checkout v2 Charge object

• createCharge($payload, $headers) → POST to "$version/charges"
• getCharge($chargeId, $headers = null) → GET to "$version/charges/$chargeId"
• captureCharge($chargeId, $payload, $headers) → POST to "$version/charges/$chargeId/capture"
• cancelCharge($chargeId, $payload, $headers = null) → DELETE to "$version/charges/$chargeId/cancel"

Amazon Checkout v2 Refund object

• createRefund($payload, $headers) → POST to "$version/refunds"
• getRefund($refundId, $headers = null) → GET to "$version/refunds/$refundId"

In-Store API

Please contact your Amazon Pay Account Manager before using the In-Store API calls in a Production environment to obtain a copy of the In-Store Integration Guide.

• instoreMerchantScan($payload, $headers = null) → POST to "$version/in-store/merchantScan"
• instoreCharge($payload, $headers = null) → POST to "$version/in-store/charge"
• instoreRefund($payload, $headers = null) → POST to "$version/in-store/refund"

Amazon Checkout v2 SPC

• finalizeCheckoutSession($checkoutSessionId, $payload, $headers = null) → POST to "$version/checkoutSessions/$checkoutSessionId/finalize"

Amazon Checkout v2 Merchant Onboarding & Account Management object

• registerAmazonPayAccount($payload, $headers = null) → POST to "$version/merchantAccounts"
• updateAmazonPayAccount($merchantAccountId, $payload, $headers = null) → PATCH to "$version/merchantAccounts/$merchantAccountId"
• deleteAmazonPayAccount($merchantAccountId, $headers = null) → DELETE to "$version/merchantAccounts/$merchantAccountId"

Amazon Checkout v2 Account Management APIs

• createMerchantAccount($payload, $headers) → POST to "$version/merchantAccounts"
• updateMerchantAccount($merchantAccountId, $payload, $headers) → PATCH to "$version/merchantAccounts/$merchantAccountId"
• claimMerchantAccount($merchantAccountId, $payload, $headers) → POST to "$version/merchantAccounts/$merchantAccountId/claim"

Using Convenience Functions

Four quick steps are needed to make an API call:

Step 1. Construct a Client (using the previously defined Config Array).

Step 2. Generate the payload.

Step 3. Execute the call.

Step 4. Check the result.

The $result will be an array with the following keys:

• 'status' - integer HTTP status code (200, 201, etc.)
• 'response' - the JSON response body
• 'request_id' - the Request ID from Amazon API gateway
• 'url' - the URL for the REST call the SDK calls, for troubleshooting purposes
• 'method - POST, GET, PATCH, or DELETE
• 'headers' - an array containing the various headers generated by the SDK, for troubleshooting purposes
• 'request' - the JSON request payload
• 'retries' - usually 0, but reflects the number of times a request was retried due to throttling or other server-side issue
• 'duration' - duration in milliseconds of SDK function call

The first two items (status, response) are critical. The remaining items are useful in troubleshooting situations.

To parse the response in PHP, you can use the PHP json_decode() function:

If you are a Solution Provider and need to make an API call on behalf of a different merchant account, you will need to pass along an extra authentication token parameter into the API call.

An alternate way to do Step 2 would be to use PHP arrays and programmatically generate the JSON payload:

Convenience Functions Code Samples

Alexa Delivery Notifications

Amazon Checkout v2 - Create Checkout Session (AJAX service example)

Amazon Checkout v2 - Create Checkout Session (standalone script example)

Amazon Checkout v2 - Get Checkout Session

Amazon Checkout v2 - Update Checkout Session

Amazon Checkout v2 - Complete Checkout Session API

Amazon Checkout v2 - Get Charge Permission API

Amazon Checkout v2 - Update Charge Permission API

Amazon Checkout v2 - Close Charge Permission API

Amazon Checkout v2 - Create Charge API

Amazon Checkout v2 - Get Charge API

Amazon Checkout v2 - Capture Charge API

Amazon Checkout v2 - Cancel Charge API

Amazon Checkout v2 - Create Refund API

Amazon Checkout v2 - Get Refund API

Amazon Checkout v2 - Get Buyer API

Generate Button Signature (helper function)

The signatures generated by this helper function are only valid for the Checkout v2 front-end buttons. Unlike API signing, no timestamps are involved, so the result of this function can be considered a static signature that can safely be placed in your website JS source files and used repeatedly (as long as your payload does not change).

Manual Signing (Advanced Use-Cases Only)

This SDK provides the ability to help you manually sign your API requests if you want to use your own code for sending the HTTPS request over the Internet.

Example call to getPostSignedHeaders function with values:

Example request method:

Example call to createSignature function with values:

(This will only be used if you don't use getPostSignedHeaders and want to create your own custom headers.)

Reporting APIs code samples

Amazon Checkout v2 Reporting APIs - GetReport API

Amazon Checkout v2 Reporting APIs - GetReportById API

Amazon Checkout v2 Reporting APIs - GetReportDocument API

Amazon Checkout v2 Reporting APIs - GetReportSchedules API

Amazon Checkout v2 Reporting APIs - GetReportScheduleById API

Amazon Checkout v2 Reporting APIs - CreateReport API

Amazon Checkout v2 Reporting APIs - CreateReportSchedule API

Amazon Checkout v2 Reporting APIs - CancelReportSchedule API

Amazon Checkout v2 Reporting APIs - GetDisbursements API

Amazon Checkout v2 SPC - finalizeCheckoutSession API

Sample codes for Account Management APIs

For more details related to Account Management APIs, please refer to this Integration Guide.

Amazon Checkout v2 Account Management APIs - createMerchantAccount API

Amazon Checkout v2 Account Management APIs - updateMerchantAccount API

Amazon Checkout v2 Account Management APIs - claimMerchantAccount API