Skip to main content

Set up and configure a Vantiv (Now Worldpay) gateway instance


Set up and configure a Vantiv (Now Worldpay) gateway instance

To process payments through Vantiv, set up and configure a Vantiv (Now Worldpay) gateway instance by using the information in this article. For gateway reconciliation, use the Vantiv (Reconciliation Only) gateway instance.


You must link your Vantiv (Now Worldpay) merchant account with Zuora's Presenter IDs. The Presenter IDs of Zuora are:

  • Pre-Live: ZUORATST12
  • Post-Live/Production: ZRAINC12

Confirm with Vantiv (Now Worldpay) support whether your Merchant ID is enabled for the Vantiv (Now Worldpay) test environment and whether your Merchant ID is linked with Zuora's Vantiv Presenter ID for the test environment. Vantiv (Now Worldpay) 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 (Now Worldpay) Gateway via Zuora, the request is sent with the Zuora's Presenter 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 (Now Worldpay) 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.

Additionally, you must enable the Vantiv (Now Worldpay) payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.


Take the following steps to set up and configure a Vantiv (Now Worldpay) gateway instance:

  1. Click your username at the top right and navigate to Settings > Payments > Setup Payment Gateway
  2. On the Configure Gateway Instance tab, select Vantiv(Now WorldPay) 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 (optional)
  • Merchant ID
  • Cards Accepted
  • Default Authorization Amount
  • Verify new payment method (optional)
  • Verify updated payment method (optional)
  • Commerce Indicator 

Specific configuration fields

Vantiv (Now Worldpay) 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.

Enter 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 each Merchant ID number.

If the Use Gateway Test Environment checkbox is selected, you also need to 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. 

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)

Report Group

Report groups are used to separate your transactions into different categories so that you can view financial reports by a specific report group name.

Store Token

If the Store Token checkbox is selected, the unique cnpToken for the Credit Card transactions from the Gateway is stored in the TokenId field, which can be used for querying in reports.

Disable eCheck Verification

The eCheck Verification feature requires advanced permissions on the gateway side. By selecting the Disable eCheck Verification checkbox, the eCheck Verification API requests will not be performed. 

Advanced Fraud Tool Kit Support

This is the advanced feature to detect fraud transactions. This feature requires advanced permissions or setups on the gateway side. Currently, Zuora supports this feature only by making API requests.

To use this feature, you must use the following required gateway option fields in API requests:

  • gwOptions_customAttribute1
  • gwOptions_customAttribute2
  • gwOptions_customAttribute3
  • gwOptions_customAttribute4
  • gwOptions_customAttribute5
  • gwOptions_threatMetrixSessionId

Enable Descriptor/Custom Billing Support

The customBilling field allows you to specify the custom billing descriptor for the transaction. This billing descriptor is used instead of the descriptor that is defined as the default billing descriptor. If you do not define this element, the system will use the default descriptor. This feature requires configured setups or permissions from the gateway. 

Merchant Phone Number

The Phone number is used to configure the Custom Billing support with the gateway. This field is required if the Enable Descriptor/Custom Billing Support checkbox is selected. 

Enable 3D Secure (3DS) support

The 3D Secure provides real-time authentication of the cardholder for online merchants. Transactions that are authenticated receive chargeback and interchange benefits. This feature requires configured setups or permissions on the gateway side. 

Enable L2

By selecting this checkbox, you are agreeing to send extra information related to a transaction in order to qualify for certain purchasing interchange rates. Extra information is required by the gateway, which must be submitted to achieve Level 2 Interchange rates for Visa and MasterCard.

For more information about Zuora's support for Level 2 data, see Level 2 and Level 3 Card Data.

Enable L3

By selecting this checkbox, you are agreeing to send extra information related to a transaction in order to qualify for certain purchasing interchange rates. Extra information is required by the gateway, which must be submitted to achieve Level 3 Interchange rates for Visa and MasterCard.

After you have enabled this feature, you must also enter CommodityCode  in the Custom Field Commodity Code API Name field for Level 2 and Level 3 card data processing. See Custom Field Commodity Code API Name for more information about this field.

For more information about Zuora's support for Level 3 data, see Level 2 and Level 3 Card Data.

Enable Gateway Reconciliation

Select this checkbox to enable the Gateway Reconciliation feature for the Vantiv (Now Worldpay) gateway. For more information about the supported Gateway Reconciliation service, see Overview of Vantiv payment gateway integration

L3 ItemData Limit

This is the maximum number of invoice items to be considered while sending Level2/Level3 information. The default value is 98. 

Custom Field Commodity Code API Name

This is the API Name of the commodity code custom field. Commodity code is one of the mandatory fields to qualify for Visa Level 3 Interchange rates. This custom field must be created in the product rate plan charge level.

You must enter the custom field API names without the __c suffix.

Use Default Authorization Amount

If this field is selected, the value specified in the Default Authorization Amount field will be submitted when verifying the card. If this field is not selected, a zero authorization amount will override the value in the Default Authorization Amount field and will be used on card verification.

Test 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 (Now Worldpay) production environment.

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.

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.