Buy with Prime | Developer Documentation
Documentation

Use Amazon Pay for Shopper Identity

📘

Buy with Prime API is now available for early access

Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.

Sign Up

You can integrate Buy with Prime with Amazon Pay, through which you can authenticate a shopper and verify that they are a Prime member. The shopper can check out using Buy with Prime while using the address information and payment methods in their Amazon account.

At checkout, after the shopper signs in using their Amazon account credentials, Amazon Pay creates a checkout session and redirects the shopper to the checkout page with checkoutSessionID as a request parameter. You can use checkoutSessionID to identify details of the shopper including their name and email address.

In the sandbox environment, to call deliveryPreview, shopperBwPEligibility, or createOrder, you must use one of the Sandbox shopper identity tokens.

Register with Amazon Pay

Prerequisites

For use of Amazon Pay with Buy with Prime, Amazon Pay is available to merchants in the US.

To register as an individual, you must be at least 18 years of age, and you must be a US citizen or a US permanent resident, not a US visa holder.

If registering on behalf of a business, you must be duly authorized to enter into agreements on behalf of the business, and the business entity must be authorized to do business in the US. The business must have a US-based street address, a US-based bank account, a credit card associated with a US street address, and a US-based phone number.

Registration

If you don’t have an existing Amazon Pay account that qualifies for use with Buy with Prime, register with Amazon Pay.

Make sure you have the following before starting the registration process:

  • A US-based phone number for the registration service to contact you
  • A credit card issued by a US-based bank
  • The website URL where you plan to use Amazon Pay.

You can set up the following after registration:

  • A checking account with a US-based bank, for disbursement
  • Your business taxpayer ID, Employer Identification Number (EIN), or personal Social Security number, for the online tax document interview.

Integrate with Amazon Pay

Buy with Prime requires that you use Amazon Pay Checkout v2. For details, see Amazon Pay Checkout v2.

If your custom implementation integrates directly with the Buy with Prime API, follow the instructions in Amazon Pay API documentation. For details, see Amazon Pay API documentation.

Set the Buy with Prime information in the payload. The following is an example of a payload configuration for Buy with Prime. 

{  
... // other attributes  
    "orderType": "BuyWithPrime",  
    "cartDetails":  
    {  
        "siteId": "BwP_SiteID",  
        "type": "BuyWithPrime",  
        "lineItems":  
        [  
            {  
                "sku": "BwP_SKU",  
                "quantity": 0  
            }  
        ]  
    }  
}

Get settlement reports for Amazon Pay

Settlement reports provide a detailed breakdown of your Amazon Pay account activity for a given settlement period, including transactions and settlements.

You can use Seller Central to manage and download settlement reports. For details, see Settlement Reports in the Amazon Pay Help. You can also use the Amazon Pay API to manage and retrieve reports. For details, see Reports in the Amazon Pay API documentation.

Related topics

Updated 2 days ago