The Amazon Pay gateway is a dynamic eCommerce solution that helps you create a seamless customer experience by offering more payment options, security features, and easy integration.
Supported Payment Methods
The Amazon Pay integration supports the following payment method:
Configure the Amazon Pay Gateway
- Click your username at the top right and navigate to Settings > Payments > Setup Payment Gateway.
- Select Amazon Pay from the Gateway Type drop-down list.
- Click create gateway.
- In the New Gateway configuration page, specify values for the gateway configuration fields.
- Click save gateway information.
Common Configuration Fields
There are some common fields you must complete for every gateway configuration. We recommend reviewing Setting Up Payment Gateways for information on these fields:
Name: Choose a name that identifies this payment gateway. We recommend using a name that helps your users identify the gateway.
Use Gateway Test Environment: Select this check box if you want Billing to use the payment gateway's test service URL. This allows you to test payment transactions while you are setting up your Billing.
You must obtain the Seller ID and MWS Auth Token from their Amazon Seller Central prior to setting up the Amazon Pay gateway.
Store Name: The name entered in this field will appear as the store name in confirmation emails sent by Amazon to the customer
Seller Note: A description of the billing agreement that is included in the email sent when the billing agreement is confirmed. For example, “You have authorized TMG to use Amazon Pay for future purchases”. A maximum of 512 characters is allowed for this field.
Seller Transaction Note: A description of the transaction that is included in the email sent when the fund is captured. For example, “Your unlimited access is now available”. A maximum of 255 characters is allowed for this field.
Seller ID: This uniquely identifies the merchant. You get this identifier from Amazon Seller Central.
MWS Auth Token: This token is used to verify that we (Zuora) have permission to make API calls on behalf of you identified by the Seller ID. This is obtained in Amazon Seller Central.
Default Authorization Amount: For this particular payment gateway, this field has no effect.
Verify new payment method (optional): Whether to verify the new credit card.
Verify updated payment method (optional): Whether to verify the updated credit card.
After you have entered the necessary information, click save gateway information.
Create Amazon Pay Payment Method via API
You can create an Amazon Pay payment method in one of the following ways:
- Use the Subscribe API to create an account and corresponding payment methods.
- Use either Create account or CRUD: Create account to create an account, and then create a payment method with the CRUD: Create payment method API.
Note that an account is required for creating a payment method.
Credit Card Reference (CCRef) Transactions
Credit Card Reference transactions are payment transactions that utilize a transaction ID from a previously authorized transaction to process a subsequent payment. The transaction ID is a token that replaces sensitive payment method information (for example, a credit card or a bank account number) so the transaction ID or token is stored in Zuora as the payment method in place of sensitive card data or bank account information. To use the CCRef payment method, contact Zuora Global Support to enable the CCRef for your tenant.
Configure the CCref Payment Method
This is the UI flow Zuora expects you to set up on your website.
Note: You only need to complete the first 3 steps, then send the billingAgreementId to Zuora. Zuora can complete the remaining steps for you.
The customer has a payment method with Amazon and selects it with Widgets on your website. Zuora does not store any information about the payment method, for example, credit card number, security code, billing address, and so on. These widgets also help to create the Billing Agreement. Detailed instructions on how to set up the widgets on your site can be found here.
- Login Widget
The user clicks this button to login to Amazon. After successfully logging in, the next widgets can be rendered.
- Addressbook and Wallet Widget
The user selects a shipping address which is stored in the Billing Agreement. If you do not want to use this widget, refer to this article for more information. If that is not the case, then after the user selects an address from the AddressBook, the Wallet widget can be rendered.
With this widget, the user selects a payment method that will be stored in the Billing Agreement. Zuora will not be able to access information about this payment. Instead, we will use a token that is generated at the end of the user flow to authorize and capture on payment methods.
- Repeat Payment Authorization Widget
This is the final widget in the user flow. It collects the user’s consent for recurring payments, and if it is not checked, then recurring payments will not be possible. After the user checks this box, the Billing Agreement will be ready for Zuora to manipulate and use for card validation, captures, voids, etc. At this point, you should send Zuora the BillingAgreementId which you can get by calling getAmazonBillingAgreementId() on the billingAgreement object.
Activate Amazon Pay Payment Method
You must activate the Amazon Pay for your tenant before you can use this payment method. You can do this by clicking on your username and then select Payment settings > Payments > Amazon Pay.
Sign up as A Developer
Sign up as a developer to link your merchant account to Zuora seller account. This step is required to authorize Zuora to make delegated API requests to Amazon Pay on your behalf.
The following lists include the Zuora Developer IDs for each region that Zuora supports:
- Zuora Amazon Pay Developer IDs:
- US Seller Developer ID: 2058-5280-5905
- UK Seller Developer ID: 1794-8997-9886
- EU Seller Developer ID: 0230-4082-5466
- Japan Seller Developer ID: 7595-2258-1807
- Zuora Platform IDs:
- US Platform ID: A33MDR0GNBPE8W
- UK Platform ID: A28Y5WYBGGNWO7
- EU Platform ID: A3TVLMHVE3W5O8
- Japan Platform ID: A2IPQ7QYREP8F4
Handle Authorization Declines
In case of an authorization decline, please refer to the response from Zuora to check for the reason code.
- If the reason code is InvalidPaymentMethod, re-render the Amazon Pay wallet widget and ask the buyer to choose another payment instrument. Please follow the synchronous declined handling in Prepare to handle declined authorizations for further instructions.
- In case of a reason code other than InvalidPaymentMethod, please redirect the buyer back to the order review page, and ask them to choose a payment method other than Amazon Pay. It is recommended to log out from Amazon account as explained in Add a button widget.
Testing Your Configuration
We recommend that you test your payment gateway by using both your payment gateway's sandbox and production (live) environments. Once you have completed testing in the gateway's sandbox environment, it is recommended that you perform a test in your live production environment with real information. If there are any differences in the configuration of your sandbox and production accounts, testing in production ensures your production merchant account is set up properly and can successfully connect to the production environment.
You can use the testing scenarios provided by the gateway vendor to test your integration. See Amazon Pay's documentation for instructions on testing your integration.