Welcome to Zuora Product Documentation

Explore our rich library of product information

Overview of Vantiv payment gateway integration

Learn about integrating with Vantiv (Now Worldpay) for payment processing, reconciliation, and support for Level 2 and Level 3 card data.

Zuora supports the following versions of Vantiv payment gateway integration:

  • Vantiv (Now Worldpay) - To process payments, use this integration version and your Merchant ID. This version is the latest integration version for payment processing.

  • Vantiv (Reconciliation Only) - To process gateway reconciliation, use this integration version and your Organization ID.

  • Vantiv Payment Gateway, API v8.10

  • Vantiv: previously called Litle gateway integration

Supprt for Level 2 and Level 3 card data processing

The Vantiv (Now Worldpay) gateway integration supports processing Level 2 and Level 3 credit card data. For more information, see the following articles:

Support for stored credential profiles

Vantiv (Now Worldpay) and Vantiv Payment Gateway, API v8.10 include support for the Stored Credential Transactions framework, but they do not support the sharing NTI feature. For details, see Support for stored credential transactions overview .

On Vantiv (Now Worldpay), if you want to submit the processingType=initialRecurring indicator field to the gateway when processing payment without an NTI on the payment method, submit a request at Zuora Global Support . After the payment is processed successfully, the NTI returned from the gateway is stored in Zuora and used in subsequent recurring transactions.

Support for network token payments

Vantiv (Now Worldpay) supports using Zuora-provisioned network tokens for supported credit card payments.

When a supported credit card payment method has a Zuora-provisioned network token, Zuora uses the network token for Vantiv payment processing instead of the raw card number.

If a network token is not available for the payment method, Zuora falls back to the raw card number.

Zuora can automatically provision a network token after a successful payment method validation or payment, including when that successful transaction was processed through another supported gateway.

Existing payment methods can receive a network token after their next successful validation or payment.

For customer-initiated unscheduled payments that use a network token, Zuora provisions a fresh cryptogram and sends it as part of the Vantiv payment request.

This capability applies to standard credit card payment methods. Apple Pay and Google Pay payment methods are not eligible for Zuora-provisioned network token provisioning.

Support for Gateway Reconciliation

Note:

To process gateway reconciliation, it is strongly recommended to use the Vantiv (Reconciliation Only) gateway integration and your Organization ID . The Gateway Reconciliation support on Vantiv (Now Worldpay) is limited.

The following Gateway Reconciliation events are supported:

  • Settlement

  • Rejection

  • Chargeback

The following three reports must be set up by your Worldpay representative or enabled for your merchant account on . Once the reports have been set up, you have to contact Worldpay to set up the SFTP username and password for your file repository and ensure the daily generated reports are deposited into the SFTP server. Then you should add your SFTP username and password to your gateway settings and ensure that the Enable Gateway Reconciliation check box is selected.

  • Financial_Detail_ChargebackFinancialBySettlementDate${rptCategoryId}_${organizationId}_$ {targetDay}

  • Financial_Detail_NssByTxnBySettlementDate${rptCategoryId}${currencyAlpha}${negativeRefund}_${organizationId}_${targetDay} (you must specify the negative refund field as conveyed negative refund .)

  • Declined_Transactional_Report_${organizationId}_${targetDay}

You must use the settlement date instead of the activity date for report generation. Refer to Worldpay eComm Scheduled Secure Reports Reference Guide to learn more about these reports.

Example valid report names are:

  • Financial_Detail_NssByTxnBySettlementDate0ConveyedNegativeRefund_65600_20200813.CSV

  • Declined_Transaction_Report_65600_20200813.CSV

  • Financial_Detail_ChargebackFinancialBySettlementDate0_65600_20200813.CSV

Note that if you manually open a generated report on your merchant console, Vantiv will automatically archive the report. Thus the automated file pull request from Zuora will fail.

For more information about enabling and configuring the Gateway Reconciliation service, see the following articles:

For ACH payment reconciliation, Zuora also supports hourly processing of the Vantiv eCheck Return report and the Vantiv eCheck NOC Update report when these features are enabled. The eCheck Return report updates matching ACH payments with earlier bank return results, and the eCheck NOC Update report updates matching ACH payment methods with corrected bank account details.

Support for Payment Method Updater

To set up the Vantiv Payment Method Updater service in Zuora, see Configure Vantiv Payment Method Updater for more information.

ACH return reconciliation

When enabled, Zuora can reconcile ACH returns using the Vantiv eCheck Return CSV report. Zuora downloads the report from Vantiv on an hourly basis, updates matching ACH payments to Error, and records the NACHA return code and bank‑supplied reason on the payment. For configuration steps and detailed behavior, see Reconcile ACH returns using the Vantiv eCheck Return report.