# Amazon Pay API Integration
* [Creating Amazon Pay App And Adding Your Domain](#checkoutchampamazonpayapiintegration-creatingamazonpayappandaddingyourdomain)
* [Obtain Amazon Pay MID Credentials](#checkoutchampamazonpayapiintegration-obtainamazonpaymidcredentials)
* [Create Amazon Pay MID](#checkoutchampamazonpayapiintegration-createamazonpaymid)
* [Add Amazon Pay Widgets and JavaScript to Your Lander Code](#checkoutchampamazonpayapiintegration-addamazonpaywidgetsandjavascripttoyourlandercode)
* [Send Amazon Pay Parameters with Import Order API Call](#checkoutchampamazonpayapiintegration-sendamazonpayparameterswithimportorderapicall)
* [Transaction Flow](#checkoutchampamazonpayapiintegration-transactionflow)
* [Upsells](#checkoutchampamazonpayapiintegration-upsells)
* [Enable Recurring Payments](#checkoutchampamazonpayapiintegration-enablerecurringpayments)
* [Errors/Decline Messages](#checkoutchampamazonpayapiintegration-errors-declinemessages)
### Creating Amazon Pay App And Adding Your Domain
1. Log in to
2. Go to **Integration → Integration Central**
3. Go to **Manage client ID/store ID(s)** section at the bottom of the page and click “**Create new client ID/store ID**” or click “**View client ID/store ID(s)**” and “**Edit**” to update existing app.
4. Add your lander domain to **JavaScript origins** and **return URLs** and create or update.
### Obtain Amazon Pay MID Credentials
1. Log in to
2. Go to **Integration** → **MWS Access Key**
3. Click the gold “**Copy your keys**” button at the top right
4. Copy the credentials shown in the popup.
### Create Amazon Pay MID
1. In the CRM, go to Merchants->MID List
2. Click the green plus sign to create a new MID
3. Select **Amazon Pay** as Gateway field
4. Fill in copied credentials (**merchant\_id, access\_key, secret\_key, client\_id, client\_secret**)
5. Fill in MID Title, Descriptor, MID #
6. Click “Create MID”
### Add Amazon Pay Widgets and JavaScript to Your Lander Code
Sample Code from Amazon docs:
```
. . .
...
. . .
```
For more information on adding Amazon Pay widgets and Javascript visit
### Send Amazon Pay Parameters with Import Order API Call
Send these parameters during Import Order API call
* **paySource**: “AMAZON”
* **amazonBillerId**: ID of Amazon Pay MID in the CRM (found on the MID List page)
* **amazonAddressConsent**: access\_token returned to your checkout page via the URL by Amazon
* **amazonOrderId**: obtained in the AddressBook `onOrderReferenceCreate` function with `orderReference.getAmazonOrderReferenceId();`
### Transaction Flow
Customer clicks Amazon-generated Amazon Pay button on checkout page.
New window pops up for customer to log into Amazon
Customer returned to checkout page with **access\_token** in URL query string.
access\_token is used with Amazon profile API to obtain the firstName, lastName, and emailAddress parameters to send on Import Order API call. Send profileResponse.email as **emailAddress** parameter on Import Order API call. Parse profileResponse.name and send as **firstName** and **lastName** parameters on Import Order API call.
Call functions to display the Amazon AddressBook and Wallet widgets.
Obtain Amazon Order Reference ID to send on Import Order API call as **amazonOrderId** parameter in the AddressBook `onOrderReferenceCreate` function with `orderReference.getAmazonOrderReferenceId();`
Customer chooses shipping address and payment method from Amazon-generated widgets.
Import Order with parameters: **paySource**=AMAZON, **amazonBillerId**, **amazonOrderId**, **amazonAddressConsent** (access\_token).
### Upsells
Repeat JavaScript process on your upsell page and send **amazonBillerId**, **amazonOrderId**, **amazonAddressConsent** on Import Upsale API call.
### Enable Recurring Payments
Follow the same integration steps as for one-time payments above and replace the Amazon AddressBook and Wallet widget code and add the Consent widget code as follows:
```
```
```
```
```
```
For more information on adding Amazon Pay widgets and Javascript visit
The customer will be required to check the “Use my selected payment method for future purchases and payments to this merchant” box in the Amazon-generated consent widget to complete the purchase.
Send the `amazonBillingAgreementId` as the **amazonOrderId** parameter on your Import Order API call.
***
### Errors/Decline Messages
Below you will find common errors that other users have encountered when using Amazon Pay.
| Error | Cause | Fix |
| -------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| InvalidPaymentMethod | The customer’s payment method inside Amazon is no longer valid. | Customer must ensure that all payment methods inside their Amazon account are valid. |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://help.checkoutchamp.com/crm/gateway-setup/gateway-integrations/amazon-pay-api-integration.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.