Skip to main content

Set up and configure a Amazon Pay Checkout v2 gateway instance

Zuora

Set up and configure a Amazon Pay Checkout v2 gateway instance

  1. Last updated
  2. Save as PDF

This payment gateway integration can be requested through the Specialized Payment Connections service at an additional cost.

Set up and configure a Amazon Pay Checkout v2 gateway instance by using the information in this article, including the configuration procedure, descriptions of the configuration fields and references for testing the payment gateway.

Prerequisites

Make sure you have requested support for Amazon Pay Checkout v2 payment gateway integrations through the Specialized Payment Connections service.

Configuring Amazon Pay Checkout v2  

Complete the following steps to set up and configure Amazon Pay Checkout v2 payment gateway instance:

  1. Click your username at the top right, and navigate to Settings > Payments > Set Up Payment Gateway.
  2. On the Configure Gateway Instance tab, select AmazonPay, Checkout V2 from the Gateway Type dropdown list.
  3. Click Create Gateway.
  4. On the gateway settings page, specify values for the configuration fields. See the following Configuration fields section for more information on the fields. Note that all the configuration fields do not support the vertical line character "|". For password fields, if your gateway assigns a password containing this character, Zuora will display a validation error. To resolve this issue, contact your gateway provider to request a new password without the unsupported character.
  5. Click Save Gateway Information.

Setting up the payment method

Complete the following steps to set up and Amazon Pay Checkout v2 as a payment method:

  1. Click your username at the top right, and navigate to Settings > Payments > Set Up Payment Gateway.
  2. Click Edit.
  3. Enable AmazonPay.
  4. Click Save.

To Set up a payment method through the API, use Create a payment method. 

Configuration fields  

Basic Information  

  • Name: Specify a name for the gateway instance.
  • Use Gateway Test Environment: When setting up the payment gateway integration, if you want Zuora to use the payment gateway's test service URL, select this checkbox.

Credentials

The following credentials provided by Amazon Pay must be configured. When a merchant account is set up with the Amazon Pay Checkout v2 gateway, the following information is assigned by the gateway. The information is used to identify the account through which the transaction will be processed.

  • Merchant Id
  • API PublicKey
  • API Private key file
  • Region (Japan is the only supported region currently; the allowed value is JP) 

Supported payment operations 

The Checkout.com integration supports the following payment operations:

  • Payment
  • Referenced refund

Support for IPN

Events related to AmazonPay V2 Checkout payment methods also trigger Instant Payment Notification (IPN). This messaging service immediately notifies merchants about the status of the changes in payment methods. 

Test the configuration

For basic guidance on how to test payment gateway integrations within a sandbox environment, see Test payment gateway integration.

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.