Skip to main content

Set up and configure Vantiv Payment Gateway API v8.10 or Vantiv gateway instance


Set up and configure Vantiv Payment Gateway API v8.10 or Vantiv gateway instance

The Vantiv Payment Gateway API v8.10 or Vantiv gateway integration versions described in this article are no longer under active development. Vantiv (Now Worldpay) is the latest integration version provided by Zuora. See Overview of Vantiv payment gateway integration for details.

Set up and configure a Vantiv Payment Gateway API v8.10 or Vantiv gateway instance by using the information in this article.


Contact Zuora Global Support to enable this gateway in your tenant.

Confirm with Vantiv support whether your Merchant ID is enabled for the Vantiv test environment and whether your Merchant ID is linked with Zuora's Vantiv Submitter ID for the test environment. Vantiv gateway does not permit access to its test environment using your production Merchant ID, so you must obtain a test Merchant ID for testing purposes. 

When your request is sent to the Vantiv Gateway via Zuora, the request is sent with the Zuora's Submitter ID in all environments. Your Merchant IDs can vary per your gateway settings for the production and testing environments.

If you plan to process both credit card and ACH transactions, we recommend that you configure two separate instances of the Vantiv Gateway within Zuora. The first configuration with verification turned on can process credit cards, and the second configuration with verification turned off can process ACH transactions. This setup avoids issues caused by eCheck verification on ACH transactions.


Take the following steps to set up and configure a Vantiv Payment Gateway API v8.10 or Vantiv gateway instance:

  1. Click your username at the top right and navigate to Settings > Payments > Setup Payment Gateway
  2. Select Vantiv Payment Gateway, API v8.10 or Vantiv from the Gateway Type drop-down list.
  3. Click Create Gateway.
  4. Complete the configuration for the gateway instance. For more information about the configuration fields, see "Configuration fields" in the following section.
  5. Click save gateway information after entering the necessary information.

Configuration fields

Common configuration fields

There are some common fields you must complete for every gateway configuration. We recommend reviewing our Setup Payment Gateway documentation for information on these common fields: 

  • Name
  • Use Gateway Test Environment
  • Test Environment Type
  • Merchant ID
  • Cards Accepted
  • Default Authorization Amount
  • Verify new payment method (optional)
  • Verify updated payment method (optional)

Specific configuration fields

Vantiv Credentials

In addition to the common fields, every gateway has unique requirements and information (such as credentials) that you must provide to configure the gateway in Zuora.

Click and select the Merchant ID number for the gateway configuration. The Merchant ID number should be the same one you provided to Zuora Global Support to enable in your tenant, and the ID(s) will appear as a picklist in the gateway configuration page. If you have more than one Merchant ID number, you can set up multiple gateway configurations for the Merchant IDs and provide all the Merchant ID numbers to Zuora Global Support for enablement.

If the Use Gateway Test Environment option is selected, click and select the test environment type in the Test Environment Type field. The Pre Live and Post Live environments are available.

Pre Live environment

The Pre Live test environment is the platform used for all merchant testing. You should use this environment if you are a newly on-boarding Vantiv merchant or if you are an existing Vantiv merchant seeking to incorporate additional features or functionalities.

Post Live environment

The Post Live testing environment is intended for merchants that are already fully certified and submitting transactions to the Vantiv Production platform, but wish to perform regression or other tests to confirm the operational readiness of modifications to their own systems. 

Enable AVS Filtering

If enabled, Zuora will decline Credit Card transactions for certain AVS response codes returned by the gateway, even if the gateway has approved the transaction. Default is disabled.

Enable CVV Filtering

If enabled, Zuora will decline Credit Card transactions for certain CVV response codes returned by the gateway, even if the gateway has approved the transaction. Default is disabled.

AVS and CVV Response Codes

AVS Response Codes Description
10 5-Digit zip matches, address does not match
11 9-Digit zip matches, address does not match
12 Zip does not match, address matches
13 Postal code does not match, address matches
20 Neither zip nor address match
33 General error
40 Address failed Vantiv edit checks
CVV Response Codes Description
N No match

Support Recurring

If you accept credit card payment methods, you may consider enabling the Support Recurring option. If Support Recurring is selected, Zuora will mark such payments as recurring when submitting the sale payment transactions to Vantiv. For recurring payments, this option may result in reduced fees and greater acceptance with your merchant bank. Check with Vantiv  to verify that this is available and appropriate for your account.

Commerce Indicator

The Commerce Indicator identifies the source channel of the transaction request (i.e., the environment that the cardholder used to provide the payment card details to the merchant) and the type of transaction being processed. Select one of the following values from the list:

  • E-Commerce (default)
  • Installment
  • Mail Order
  • Recurring
  • Retail
  • Telephone
  • Recurring Telephone (eCheck only)

Set Up First and Recurring E-Commerce Transactions

Perform the following steps to ensure that first and recurring transactions are set up properly:

  1. Verify the Vantiv gateway instance is set up in the following way:
    • Check Support Recurring
    • Commerce Indicator set to E-Commerce
  2. Check the transaction logs to see if the indicator value is set as expected.

Testing the configuration

We recommend testing your selected payment gateway using both your payment gateway's test and production (live) environments.  Once you have completed testing in the gateway's test environment, it is recommended that you perform a test in your live production environment with a real credit card. If there are any differences in the configuration of your testing and production accounts, testing in production ensures your production merchant account is set up properly and can successfully connect to the production environment.

Accessing Your Gateway's Test Environment  

If Use Gateway Test Environment is selected in your payment gateway configuration, Zuora will direct payment transactions to the Vantiv testing environment that you chose in the Test Environment Type field in the Credentials section.

 You will be accessing a test environment linked to Zuora's Submitter ID. 

If Use Gateway Test Environment is not selected, Zuora will direct payment transactions to the Vantiv production environment.

Test Credit Cards and Testing Scenarios

Test credit card numbers and testing scenarios can be found in the Vantiv XML Reference Guide. Please work with your Vantiv implementation analyst to retrieve all necessary information for testing. Contact Vantiv Support for the latest version of the Vantiv XML Reference Guide. This guide provides specific credit card account numbers and data to include in your testing to generate specific gateway responses.

General Testing Information

Integration Testing

Zuora has been certified with Vantiv as an integration partner and maintains the integration on an ongoing basis, thoroughly testing the integration with every new release. The Vantiv integration documentation is helpful if you are integrating Vantiv directly with your website, however, you do not need to perform any integration or certification testing to submit transactions to Vantiv via the Zuora application. The intended audience for the integration guides are technical integrators, however, these documents can be helpful to non-technical integrators who can refer to it for information on testing and troubleshooting gateway errors (as described below). 

Performance and Volume Testing

In general, gateway testing environments are intended to give merchants the opportunity to test their gateway and integrations to their gateway, in order to work out any bugs before going to the production environment. Some gateway test environments are shared amongst multiple merchants, and other gateways provide unique testing environments for each merchant. Additionally, gateway test environments (also referred to as certification or sandbox environments) do not have the same high availability or performance capability as production environments. As such, they are not intended for load testing. Merchants performing high volumes of load testing that puts a stress on a shared test environment may receive a warning from the gateway or have their access to the testing environment suspended.