Zuora
Last updated: April 2, 2025
To integrate with Zuora, you must first set up and test your integration in the Test environment, and then move your integration to the Live environment.
You must create a private key to configure the integration,
- Sign in to the Test environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Secret API key.
- Give the API key a description. This will help you identify what it's used for.
- Under Scopes, select Default.
- Disable the Allow any processing channel setting.
- Select the processing channel you want to use for Zuora payments from the list.
- Select Create key.
- Copy your private API key securely. You'll need it to configure the plugin.
Note
For security, you cannot view the private API key again after you've left the Create a new key page. Ensure you copy its value securely before you exit or close the window.
In your Zuora dashboard:
- Locate your username at the upper-right corner of the dashboard, and select it.
- Go to Settings > Payments > Set Up Payment Gateway.
- In the Configure Gateway Instance tab, select Checkout.com from the Gateway Type dropdown.
- Select Create Gateway.
- Configure your gateway instance using the following options:
- Name: Enter an alphanumeric value to describe the gateway.
- Use Gateway Test Environment: Enabling this option marks all transactions as tests and routes the transactions to the test environment.
- Cards Accepted: Select the cards you want to accept through this gateway. Ensure that your gateway's merchant account is also configured to accept the selected cards.
- Default Authorization Amount: The amount used to validate credit cards. By default, this is set to
1. - Verify new payment method (optional): Enabling this option triggers a validation call for each new payment method.
- For ACH, the verification is made through the ValidiFi account validation service. To verify new ACH payment methods, you must enable the support for ValidiFi service option.
For more information, see Zuora's instructions to enable support for ValidiFi account validation. - For SEPA, you must send the source ID from Checkout.com in the
MandateIDfield when creating the payment.
- For ACH, the verification is made through the ValidiFi account validation service. To verify new ACH payment methods, you must enable the support for ValidiFi service option.
- Verify updated payment method (optional): Enabling this option triggers a validate call for each new payment method updated.
- Enable gateway reconciliation: Enabling this option triggers a daily job to reconcile all payments processed through the gateway.
For more information, see Zuora's Support for Gateway Reconciliation documentation. - API Key: Enter the private API key you generated in the Dashboard, prefixed with
Bearer. For example,Bearer <SECRET_KEY>. - Default Soft Descriptor (optional): Description shown after authorizing the payment. This field is required for all direct debit payment methods.
- 3DS Challenge Indicator: If 3DS2 is enabled in the Payment Pages settings, this indicator is passed to the gateway.
For more information about this indicator, see SCA compliance guide.
- Select Save Gateway Information.
Checkout.com supports the following payment methods on Zuora:
- ACH direct debit
- Apple Pay
- Card payments – along with the Real-Time Account Updater service
To learn how to enable these payment methods, see Zuora Knowledge Center – Supported payment methods.
In your Zuora sandbox account:
- Go to Customers > Customer Accounts.
- Select Add New Account and enter the required details.
- In the Payment Method field select Credit Card .
- Enter the following card details:
- Number:
4242 4242 4242 4242 - Expiry date: any future date
- CVV:
100
- Number:
- Select Save to create a customer.
- Go to Customers > Customer Accounts > Create payment.
After creating the payment, you can find the Checkout.com payment ID in the Reference ID field.
Contact Zuora to move your integration to the production environment.