PHPackages amzn/amazon-pay-api-sdk-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Payment Processing](/categories/payments) 4. / 5. amzn/amazon-pay-api-sdk-php ActiveLibrary[Payment Processing](/categories/payments) amzn/amazon-pay-api-sdk-php =========================== Amazon Pay API SDK (PHP) 2.7.0(11mo ago)505.1M—6.7%30[10 issues](https://github.com/amzn/amazon-pay-api-sdk-php/issues)7Apache-2.0PHPPHP >=5.6.1 Since Apr 8Pushed 11mo ago16 watchersCompare [ Source](https://github.com/amzn/amazon-pay-api-sdk-php)[ Packagist](https://packagist.org/packages/amzn/amazon-pay-api-sdk-php)[ Docs](https://github.com/amzn/amazon-pay-api-sdk-php)[ RSS](/packages/amzn-amazon-pay-api-sdk-php/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (2)Versions (29)Used By (7) Amazon Pay API SDK (PHP) ======================== [](#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)](https://github.com/amzn/amazon-pay-sdk-php). Requirements ------------ [](#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.34 or higher SDK Installation ---------------- [](#sdk-installation) Use composer to install the latest release of the SDK and its dependencies: ``` composer require amzn/amazon-pay-api-sdk-php ``` Verify the installation with the following test script: ``` ``` Public and Private Keys ----------------------- [](#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: ``` ssh-keygen -t rsa -b 2048 -f private.pem ssh-keygen -f private.pem -e -m PKCS8 > public.pub ``` In Linux or macOS this can be done using openssl commands: ``` openssl genrsa -out private.pem 2048 openssl rsa -in private.pem -pubout > public.pub ``` 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](https://developer.amazon.com/docs/amazon-pay-checkout/get-set-up-for-integration.html#5-get-your-public-key-id). Namespace --------- [](#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 ------------------- [](#configuration-array) ``` $amazonpay_config = array( 'public_key_id' => 'ABC123DEF456XYZ', // RSA Public Key ID (this is not the Merchant or Seller ID) 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'sandbox' => true, // true (Sandbox) or false (Production) boolean 'region' => 'us', // Must be one of: 'us', 'eu', 'jp' 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' //Amazon Signing Algorithm, Optional: uses AMZN-PAY-RSASSA-PSS if not specified 'integrator_id' => 'AXXXXXXXXXXXXX', // (optional) Solution Provider Platform Id in Amz UID Format 'integrator_version' => '1.2.3', // (optional) Solution Provider Plugin Version in Semantic Versioning Format 'platform_version' => '0.0.4' // (optional) Solution Provider Platform Version in Semantic Versioning Format ); ``` 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. ``` $amazonpay_config = array( 'public_key_id' => 'MY_PUBLIC_KEY_ID', // LIVE-XXXXX or SANDBOX-XXXXX 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'us', // Must be one of: 'us', 'eu', 'jp' 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' //Amazon Signing Algorithm, Optional: uses AMZN-PAY-RSASSA-PSS if not specified ); ``` If you have want to enable proxy support, you can set it in the $amazonpay\_config in the following way: ``` $amazonpay_config = array( 'public_key_id' => 'ABC123DEF456XYZ', // RSA Public Key ID (this is not the Merchant or Seller ID) 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'sandbox' => true, // true (Sandbox) or false (Production) boolean 'region' => 'us', // Must be one of: 'us', 'eu', 'jp' 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2', //Amazon Signing Algorithm, Optional: uses AMZN-PAY-RSASSA-PSS if not specified 'integrator_id' => 'AXXXXXXXXXXXXX', // (optional) Solution Provider Platform Id in Amz UID Format 'integrator_version' => '1.2.3', // (optional) Solution Provider Plugin Version in Semantic Versioning Format 'platform_version' => '0.0.4', // (optional) Solution Provider Platform Version in Semantic Versioning Format 'proxy' => [ 'host' => 'proxy_host', 'port' => 'proxy_port', 'username' => 'proxy_username', 'password' => 'proxy_password', ] ); ``` Versioning ========== [](#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) ================================ [](#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 --------------------------- [](#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](https://developer.amazon.com/docs/amazon-pay-onetime/delivery-order-notifications.html) for additional information. - **deliveryTrackers**($payload, $headers = null) → POST to "$version/deliveryTrackers" Authorization Tokens API ------------------------ [](#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 ---------------------- [](#amazon-checkout-v2-api) [API Integration Guide](https://developer.amazon.com/docs/amazon-pay-api-v2/introduction.html) The $headers field is not optional for create/POST calls below because it requires, at a minimum, the x-amz-pay-idempotency-key header: ``` $headers = array('x-amz-pay-idempotency-key' => uniqid()); ``` ### Amazon Checkout v2 Buyer APIs [](#amazon-checkout-v2-buyer-apis) - **getBuyer**($buyerToken, $headers = null) → GET to "$version/buyers/$buyerToken" ### Amazon Checkout v2 CheckoutSession APIs [](#amazon-checkout-v2-checkoutsession-apis) - **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 APIs [](#amazon-checkout-v2-chargepermission-apis) - **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 APIs [](#amazon-checkout-v2-charge-apis) - **createCharge**($payload, $headers) → POST to "$version/charges" - **getCharge**($chargeId, $headers = null) → GET to "$version/charges/$chargeId" - **updateCharge**($chargeId, $payload, $headers) → PATCH 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 APIs [](#amazon-checkout-v2-refund-apis) - **createRefund**($payload, $headers) → POST to "$version/refunds" - **getRefund**($refundId, $headers = null) → GET to "$version/refunds/$refundId" ### Amazon Pay v2 Reporting APIs [](#amazon-pay-v2-reporting-apis) - **getReports**($queryParameters = null, $headers = null) → GET to $version/reports - **getReportById**($reportId, $headers = null) → GET to $version/reports/&reportId - **getReportDocument**($reportDocumentId, $headers = null) → GET to $version/report-documents/$reportDocumentI - **getReportSchedules**($reportTypes = null, $headers = null) → GET to $version/report-schedules - **getReportScheduleById**($reportScheduleId, $headers = null) → GET to $version/report-schedules/$reportScheduleId - **createReport**($requestPayload, $headers = null) → POST to $version/reports - **createReportSchedule**($requestPayload, $headers = null) → POST to $version/report-schedules - **cancelReportSchedule**($reportScheduleId, $headers = null) → DELETE to $version/report-schedules/$reportScheduleId - **getDisbursements**($queryParameters, $headers = null) → GET to $version/disbursements In-Store APIs ------------- [](#in-store-apis) 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 APIs [](#amazon-checkout-v2-spc-apis) - **finalizeCheckoutSession**($checkoutSessionId, $payload, $headers = null) → POST to "$version/checkoutSessions/$checkoutSessionId/finalize" ### Amazon Checkout v2 Merchant Onboarding & Account Management APIs [](#amazon-checkout-v2-merchant-onboarding--account-management-apis) - **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 [](#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" ### Amazon Checkout v2 Dispute APIs [](#amazon-checkout-v2-dispute-apis) - **createDispute**($payload, $headers) → POST to $version/disputes - **getDispute**($disputeId, $headers = null) → GET to $version/disputes/$disputeId - **updateDispute**($disputeId, $payload, $headers = null) → PATCH to $version/disputes/$disputeId - **contestDispute**($disputeId, $payload, $headers = null) → POST to $version/disputes/$disputeId/contest ### Amazon Checkout v2 File APIs [](#amazon-checkout-v2-file-apis) - **uploadFile**($payload, $headers) → POST to $version/files Using Convenience Functions =========================== [](#using-convenience-functions) Four quick steps are needed to make an API call: Step 1. Construct a Client (using the previously defined Config Array). ``` $client = new Amazon\Pay\API\Client($amazonpay_config); ``` Step 2. Generate the payload. ``` $payload = '{"scanData":"UKhrmatMeKdlfY6b","scanReferenceId":"0b8fb271-2ae2-49a5-b35d7","merchantCOE":"US","ledgerCurrency":"USD","chargeTotal":{"currencyCode":"USD","amount":"2.00"},"metadata":{"merchantNote":"Merchant Name","communicationContext":{"merchantStoreName":"Store Name","merchantOrderId":"789123"}}}'; ``` Step 3. Execute the call. ``` $result = $client->instoreMerchantScan($payload); ``` 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: ``` $response = json_decode($result['response'], true); $id = $response['chargePermissionId']; ``` 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. ``` $headers = array('x-amz-pay-authtoken' => 'other_merchant_super_secret_token'); $result = $client->instoreMerchantScan($payload, $headers); ``` An alternate way to do Step 2 would be to use PHP arrays and programmatically generate the JSON payload: ``` $payload = array( 'scanData' => 'UKhrmatMeKdlfY6b', 'scanReferenceId' => uniqid(), 'merchantCOE' => 'US', 'ledgerCurrency' => 'USD', 'chargeTotal' => array( 'currencyCode' => 'USD', 'amount' => '2.00' ), 'metadata' => array( 'merchantNote' => 'Merchant Name', 'communicationContext' => array( 'merchantStoreName' => 'Store Name', 'merchantOrderId' => '789123' ) ) ); $payload = json_encode($payload); ``` Convenience Functions Code Samples ================================== [](#convenience-functions-code-samples) Alexa Delivery Notifications ---------------------------- [](#alexa-delivery-notifications) ```