Get set up for integration
- 1. Register your Amazon Payments merchant account
- 2. Add domains to Seller Central
- 3. Create a Sandbox test buyer account
- 4. Download your Amazon Pay SDK library
- 5. Get your Public Key ID
1. Register your Amazon Payments merchant account
To register for an Amazon Pay merchant account, go to the Amazon Pay website for your region - United States, European Union, United Kingdom, or Japan, and complete the merchant signup process. After registration is complete, create a Sandbox buyer account for testing and get your Public Key ID to access Amazon Pay APIs. At the end of this step, you will be ready to start integration.
2. Add domains to Seller Central
Add all the domains (including protocol and custom ports) on which you want to integrate Amazon Pay to the JavaScript Origins in Seller Central, for example, https://www.example.com/ or https://www.example.com:8000/.
All domains you add must comply with the Amazon Pay Acceptable Use Policies that apply to you.
3. Create a Sandbox test buyer account
Create a Sandbox buyer account for testing. You will use the Sandbox to conduct end-to-end tests before going live. For details, see Creating Sandbox test buyer accounts. Use the Sandbox buyer account to test your Amazon Pay integration
4. Download your Amazon Pay SDK library
Use the below links to download .aar file (for Android) or xcframework (for iOS) from S3 Bucket
| United States | Europe and United Kingdom | Japan | |
|---|---|---|---|
| iOS | iOS SDK | iOS SDK | iOS SDK |
| Android | Android SDK | Android SDK | Android SDK |
Note: The iOS bundles include libraries for simulators and devices
5. Get your Public Key ID
To access Amazon Pay APIs, generate a public/private key pair and obtain the Public Key ID (Amazon Pay's identifier for the key pair) from Integration Central. Amazon Pay uses asymmetric encryption, securing communication with the key pair. Encryption ensures data remains confidential.
- Sign in to Integration Central with your Amazon Payments merchant account: US, EU, JP.
- To generate a key pair with access to the Sandbox environment, select Amazon Pay (Sandbox View) from the marketplace switcher drop-down menu.
- Select Self-developed from the Ecommerce provider or integration type dropdown menu.
- Select One-time Payments, Single Authorization from the Payment type dropdown menu.
- Click Show instructions, and then click Create keys.
-
Select Generate API credentials, and then enter your API keys name in the corresponding field.
Note: Use a descriptive name. This name is used to differentiate between multiple keys when you need to manage them in Integration Central. When naming the keys, consider who is using it and what they’re using it for.
- Click Create keys.
- By creating the Public Key ID and Private Key, a .pem file will be automatically downloaded. Store the keys in a secure location as you’ll need them to access Amazon Pay APIs. This is the only time you can download the Private Key. Unlike the Private Key file, you can return to this page at a later time to access your Public Key ID. Don’t share the Private Key with anyone. If you lose access to your Private Key, you need to create a new pair.