--- title: End of checkout placement url: amazon-pay-checkout/end-of-checkout.html --- **[Step 5 of 10]** You can also add Amazon Pay to the payment selection page of your checkout as an end of checkout payment option. Unlike the express checkout flow, the buyer will provide order-related data such as the delivery address on your site instead of selecting it from the Amazon address book. You will redirect the buyer to the Amazon Pay hosted payment page once they're ready to place their order to complete the payment process. In this step, you will configure the Amazon Pay Checkout Session object and then render the Amazon Pay button. At the end of this step, you will be able to redirect the buyer to an Amazon Pay hosted page where they can select their preferred payment instrument, review order details, and complete checkout. You must add the domains where the Amazon Pay button will be rendered to Seller Central. See Add domains to Seller Central for more information. * TOC {:toc} {::options toc_levels="3" /} *** ### 1. Add the Amazon Pay script Add the Amazon Pay script to your HTML file. Be sure you select the correct region.
```html ```
```html ```
```html ```
*** ### 2. Generate the Create Checkout Session payload To render the Amazon Pay button, you will need to provide a payload that Amazon Pay will use to create a Checkout Session object. You will use the Checkout Session object to manage the buyer’s active session on your website. The payload has the same structure as the request body for the [Create Checkout Session](../amazon-pay-api-v2/checkout-session.html#create-checkout-session){:target="\_blank"} API. Providing the payload as part of the button removes the need to call this API. In the payload, you must provide all details required for the buyer to complete checkout. **Instructions for generating button payload:** * Set `webCheckoutDetails.checkoutMode` to ProcessOrder. * Set `checkoutResultReturnUrl` to the URL that the buyer is redirected to after they complete checkout on the Amazon Pay hosted page. The Checkout Session ID will be appended as a query parameter to the provided URL. * Set `paymentDetails`: * `paymentIntent` - The payment action when the buyer clicks the Amazon “Pay Now” button * `chargeAmount` - Checkout amount * You must set `addressDetails` with the shipping address provided by the buyer if `productType` is PayAndShip. See address formatting and validation for more info on how to pass address data. * Specify the buyer information you need to complete checkout using the `scopes` parameter. If you do not set this value, all buyer information except billing address will be requested. **Optional integration steps:** * Use `merchantMetadata` to associate additional order details with this transaction. * If you registered for Amazon Pay in the EU or UK, you can use the `presentmentCurrency` parameter to charge your buyer using a different supported currency. See multi-currency integration for more info. #### Payload example ``` { "webCheckoutDetails": { "checkoutResultReturnUrl": "https://a.com/merchant-review-page", "checkoutMode": "ProcessOrder" }, "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId", "scopes": ["name", "email", "phoneNumber", "billingAddress"], "paymentDetails": { "paymentIntent": "AuthorizeWithCapture", "chargeAmount": { "amount": "10", "currencyCode": "USD" }, "presentmentCurrency":"USD" }, "merchantMetadata": { "merchantReferenceId":"Merchant-order-123", "merchantStoreName":"Merchant Store Name", "noteToBuyer":"Thank you for your order" }, "addressDetails": { "name": "Paul Smith", "addressLine1": "9999 First Avenue", "city": "New York", "stateOrRegion": "NY", "postalCode": "10016", "countryCode": "US", "phoneNumber": "212555555" } } ```
Name
Location
Description
webCheckoutDetails
(required)

Type: webCheckoutDetails
Body
URLs associated to the Checkout Session used to complete checkout. The URLs must use HTTPS protocol

Use checkoutMode to specify whether the buyer will return to your website to review their order before completing checkout
storeId
(required)

Type: string
Body
Amazon Pay store ID. Retrieve this value from Amazon Pay Integration Central: US, EU, JP
scopes

Type: list <scope>
Body
The buyer details that you're requesting access to. Specify whether you need shipping address using button productType parameter in Step 4.

Supported values:
  • 'name' - Buyer name
  • 'email' - Buyer email
  • 'phoneNumber' - Buyer phone number. You must also request billingAddress scope or use payAndShip productType to retrieve the billing address or shipping address phone number.
  • 'billingAddress' - Default billing address
Default value: all buyer information except billing address is requested if the scopes parameter is not set
chargePermissionType

Type: string
Body
The type of Charge Permission requested

Supported values:
  • 'OneTime' - The Charge Permission can only be used for a single order
  • 'Recurring' - The Charge Permission can be used for recurring orders
paymentDetails

Type: paymentDetails
Body
Payment details specified by the merchant, such as the amount and method for charging the buyer
merchantMetadata

Type: merchantMetadata
Body
Merchant-provided order details
addressDetails

Type: addressDetail
Body
Buyer provided shipping address. Only use this parameter if checkoutMode is ProcessOrder and productType is PayAndShip
*** ### 3. Sign the payload You must secure the payload using a signature. The payload does not include a timestamp so you can re-use the signature as long as the payload does not change. If you need to change the payload and your button signature is dynamic, you should decouple button render from checkout initialization to avoid re-rendering the button. **Option 1 (recommended):** Generate a signature using the helper function provided in the Amazon Pay SDKs. The signature generated by the helper function is only valid for the button and not for API requests.
``` 'MY_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', 'region' => 'US', 'sandbox' => true, 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $client = new Amazon\Pay\API\Client($amazonpay_config); $payload = '{"storeId":"amzn1.application-oa2-client.xxxxx","webCheckoutDetails":{"checkoutResultReturnUrl":"https://example.com/review.html"}}'; $signature = $client->generateButtonSignature($payload); echo $signature . "\n"; ?> ``` Source code
``` var payConfiguration = new ApiConfiguration ( region: Region.Europe, environment: Environment.Sandbox, publicKeyId: "MY_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_MY_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); var request = new CreateCheckoutSessionRequest ( checkoutResultReturnUrl: "https://example.com/review.html", storeId: "amzn1.application-oa2-client.xxxxx" ); request.ChargePermissionType = ChargePermissionType.Onetime; // generate the button signature var signature = client.GenerateButtonSignature(request); // the payload as JSON string that you must assign to the button in the next step var payload = request.ToJson(); ``` Source code
``` PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY_STRING") .setEnvironment(Environment.SANDBOX) .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); }catch (AmazonPayClientException e) { e.printStackTrace(); } AmazonPayClient client = new AmazonPayClient(payConfiguration); String payload = "{\"storeId\":\"amzn1.application-oa2-client.xxxxx\",\"webCheckoutDetails\":{\"checkoutResultReturnUrl\":\"https://example.com/review.html\"}}"; String signature = client.generateButtonSignature(payload); ``` Source code
```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'ABC123DEF456XYZ', privateKey: fs.readFileSync('tst/private.pem'), region: 'us', sandbox: true, algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const testPayClient = new Client.AmazonPayClient(config); const payload = { webCheckoutDetails: { checkoutResultReturnUrl: 'https://example.com/review.html' }, storeId: 'amzn1.application-oa2-client.xxxxx' }; const signature = testPayClient.generateButtonSignature(payload); ``` Source code
**Option 2:** Build the signature manually by following steps 2 and 3 of the signing requests guide. *** ### 4. Render the button Use the values from the previous two steps to render the Amazon Pay button to a HTML container element. The button will be responsive and it will inherit the size of the container element, see responsive button logic for details. The code below will initiate Amazon Pay checkout immediately on button click. If you need control of the click event, you can decouple button render and checkout initiation. See Amazon Pay script for more info.
#### Code sample #### Function parameters
Parameter
Description
merchantId
(required)

Type: string
Amazon Pay merchant account identifier
createCheckoutSessionConfig
(required)

Type: buttonConfig
Create Checkout Session configuration. This is a required field if you use PayAndShip or PayOnly productType
placement
(required)

Type: string
Placement of the Amazon Pay button on your website

Supported values:
  • 'Home' - Initial or main page
  • 'Product' - Product details page
  • 'Cart' - Cart review page before buyer starts checkout
  • 'Checkout' - Any page after buyer starts checkout
  • 'Other' - Any page that doesn't fit the previous descriptions
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
(required)

Type: string
Product type selected for checkout

Supported values:
  • 'PayAndShip' - Select PayAndShip if you are selling a physical product. You must pass the buyer's shipping address in the button payload
  • 'PayOnly' - Select PayOnly if you are selling a digital product
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

You do not have to set this parameter if your publicKeyId has an environment prefix (for example: SANDBOX-AFVX7ULWSGBZ5535PCUQOY7B)

Default value: false