--- title: Amazon Pay script url: amazon-pay-checkout/v1-amazon-pay-script.html --- * TOC {:toc} {::options toc_levels="3" /} *** ### Amazon Pay script Add the Amazon Pay script to your HTML file to enable front-end functionality on your website.

```html ```

*** ### 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

```html

```

```html

```

```html

```

```html

```

#### 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: US merchants - 'USD' EU merchants - 'EUR' UK merchants - 'GBP' JP merchants - 'JPY'
productType Type: string	Product type selected for checkout Supported values: 'PayAndShip' - Offer checkout using buyer's Amazon wallet and address book. Select this product type if you need the buyer's shipping details 'PayOnly' - Offer checkout using only the buyer's Amazon wallet. Select this product type if you do not need the buyer's shipping details Default value: 'PayAndShip'
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: US merchants - 'en_US' EU/UK merchants - 'en_GB', 'de_DE', 'fr_FR', 'it_IT', 'es_ES' JP merchants - 'ja_JP'
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 ```html ``` #### 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 ``` ```