Amazon Pay script
Amazon Pay script
Add the Amazon Pay script to your HTML file to enable front-end functionality on your website.
<script src="https://static-na.payments-amazon.com/checkout.js"></script>
<script src="https://static-eu.payments-amazon.com/checkout.js"></script>
<script src="https://static-fe.payments-amazon.com/checkout.js"></script>
Render the Amazon Pay button
Use amazon.Pay.renderButton() to render the Amazon Pay button to a HTML container element.
The Amazon Pay script will make an AJAX request using the configuration provided for the createCheckoutSession button parameter. The response must be in JSON format.
Code sample
<body>
<div id="AmazonPayButton"></div>
<script src="https://static-na.payments-amazon.com/checkout.js"></script>
<script type="text/javascript" charset="utf-8">
amazon.Pay.renderButton('#AmazonPayButton', {
merchantId: 'merchant_id',
createCheckoutSession: {
url: 'https://mystore/amazonpay/createcheckoutsession'
},
sandbox: true, // dev environment
ledgerCurrency: 'USD', // Amazon Pay account ledger currency
checkoutLanguage: 'en_US', // render language
productType: 'PayAndShip', // checkout type
placement: 'Cart', // button placement
buttonColor: 'Gold'
});
</script>
</body>
<body>
<div id="AmazonPayButton"></div>
<script src="https://static-eu.payments-amazon.com/checkout.js"></script>
<script type="text/javascript" charset="utf-8">
amazon.Pay.renderButton('#AmazonPayButton', {
merchantId: 'merchant_id',
createCheckoutSession: {
url: 'https://mystore/amazonpay/createcheckoutsession'
},
sandbox: true, // dev environment
ledgerCurrency: 'EUR', // Amazon Pay account ledger currency
checkoutLanguage: 'en_GB', // render language
productType: 'PayAndShip', // checkout type
placement: 'Cart', // button placement
buttonColor: 'Gold'
});
</script>
</body>
<body>
<div id="AmazonPayButton"></div>
<script src="https://static-eu.payments-amazon.com/checkout.js"></script>
<script type="text/javascript" charset="utf-8">
amazon.Pay.renderButton('#AmazonPayButton', {
merchantId: 'merchant_id',
createCheckoutSession: {
url: 'https://mystore/amazonpay/createcheckoutsession'
},
sandbox: true, // dev environment
ledgerCurrency: 'GBP', // Amazon Pay account ledger currency
checkoutLanguage: 'en_GB', // render language
productType: 'PayAndShip', // checkout type
placement: 'Cart', // button placement
buttonColor: 'Gold'
});
</script>
</body>
<body>
<div id="AmazonPayButton"></div>
<script src="https://static-fe.payments-amazon.com/checkout.js"></script>
<script type="text/javascript" charset="utf-8">
amazon.Pay.renderButton('#AmazonPayButton', {
merchantId: 'merchant_id',
createCheckoutSession: {
url: 'https://mystore/amazonpay/createcheckoutsession'
},
sandbox: true, // dev environment
ledgerCurrency: 'JPY', // Amazon Pay account ledger currency
checkoutLanguage: 'ja_JP', // render language
productType: 'PayAndShip', // checkout type
placement: 'Cart', // button placement
buttonColor: 'Gold'
});
</script>
</body>
Parameters
| Parameter
|
Description
|
| merchantId (required) Type: string |
Amazon Pay merchant account identifier
|
| createCheckoutSession (required) Type: createCheckoutSession |
Configuration for calling your endpoint to Create Checkout Session. The response must be in JSON format
|
| placement (required) Type: string |
Placement of the Amazon Pay button on your website Supported values: ‘Home’, ‘Product’, ‘Cart’, ‘Checkout’, and 'Other' |
| ledgerCurrency (required) Type: string |
Ledger currency provided during registration for the given merchant identifier Supported values:
|
| productType Type: string |
Product type selected for checkout Supported values:
|
| buttonColor Type: string |
Color of the Amazon Pay button Supported values: 'Gold', 'LightGray', 'DarkGray' Default value: 'Gold' |
| checkoutLanguage Type: string |
Language used to render the button and text on Amazon Pay hosted pages. Please note that supported language(s) is dependent on the region that your Amazon Pay account was registered for Supported values:
|
| sandbox Type: boolean |
Sets button to Sandbox environment Default value: false |
Type: createCheckoutSession
| Parameter
|
Description
|
| url (required) Type: string |
Your endpoint URL to Create Checkout Session
|
| method Type: string |
HTTP request method Supported values: 'GET', 'POST' Default value: 'POST' |
| extractAmazonCheckoutSessionId Type: string |
Checkout Session ID parameter in the response Default value: 'checkoutSessionId' |
Enable checkout info updates
Use amazon.Pay.bindChangeAction() to enable updates in case the buyer wants to select a different shipping address or payment method.
Code sample
<script type="text/javascript" charset="utf-8">
amazon.Pay.bindChangeAction('#changeButton1', {
amazonCheckoutSessionId: 'xxxx',
changeAction: 'changeAddress'
});
</script>
Parameters
| Parameter
|
Description
|
| amazonCheckoutSessionId (required) Type: string |
Amazon Pay Checkout Session identifier
|
| changeAction (required) Type: string |
Update requested by the buyer Supported values: 'changeAddress', 'changePayment' |
Sign out from Amazon
Use amazon.Pay.signout() to give buyers the option of signing out from their Amazon account.
Best practice: Give buyers the option of signing out after they complete checkout. Bind the function to a “Sign out from Amazon” link on your order confirmation page.
Code sample
<script type="text/javascript">
document.getElementById('Signout').onclick = function() {
amazon.Pay.signout();
};
</script>