Set up and configure an Alipay payment gateway instance
Set up and configure an Alipay payment gateway instance by using the information in this section.
Prerequisites
- To create Alipay gateway authentication in Zuora, submit a request at Zuora Global Support. In your request, include the following information:
- Tenant ID
- Alipay test or production environment
- An Alipay gateway authentication name that must be unique across all gateway authentication names, including those for other gateways such as Adyen and Stripe. The name should not exceed 100 characters.
Zuora generates an OAuth token, sets its status to Pending Authorize, and provides you with a Zuora merchant ID.
- You need to submit the Zuora merchant ID as ISV sub merchant ID to Alipay, and work with Alipay to complete your merchant onboarding.
Once the registration process is completed, Alipay returns the result to Zuora and Zuora sets the OAuth token status to Active.
- In the Zuora UI, enable the Alipay payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.
Procedure
To set up and configure an Alipay payment gateway instance, complete the following steps:
- Navigate to Settings > Payments > Setup Payment Gateway.
- On the Configure Gateway Instance tab, select Alipay from the Gateway Type drop-down menu.
- Click Create Gateway.
- On the gateway settings page, specify values for the configuration fields. For details about the fields, see "Configuration fields" in the following section. 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.
- Click Save Gateway Information.
Configuration fields
Basic information
- Name: Specify a name for the gateway instance.
- Use Gateway Test Environment: If you want Zuora to use the payment gateway's test service URL when setting up the payment gateway integration, select this option.
Credentials
- Agent Token: The unique token provided by Alipay.
- Data Center: The Alipay data center through which transactions are processed.
Rules
- Default Authorization Amount: Specify the minimum default amount used to authorize or validate a payment. The default value of this field is 1.
- Verify new payment method: Select this checkbox to verify the payment methods when creating them. By default, this checkbox is selected. For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful.
- Verify updated payment method: Select this checkbox to verify the payment methods when updating them. By default, this checkbox is selected. For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful.
- Settlement Currency: The ISO alpha-3 currency code of the currency that transactions are settled against.
- Order Description: Summary description of the order, which is used for user consumption records display or other further actions.
Test the configuration
For basic guidance on how to test payment gateway integrations within a sandbox environment, see Test your payment gateway integration.
For information about test accounts provided by Alipay, see Alipay's documentation.