Configure Worldpay Gateway Reconciliation
Zuora now supports reconciling electronic payment, refund, and chargeback events processed through the Worldpay 1.4 or Access Worldpay gateway integration.
For EMIS or acquire reports, Zuora will process NBT505 reports, RECON files, and chargeback notification files. Zuora also supports WPG reports (transaction status reports) and Transfer Batch reports set up by Worldpay administrators, and DART reports dedicated for the NAP platform.
- To get Reconciliation correctly set up on the Worldpay side, contact Worldpay Support and refer them to their internal resource for details about the setup procedure.
- If you are using Worldpay service level M, the Transfer Batch report is available to you. To ensure that this report is posted to the server for Zuora Gateway Reconciliation jobs, you need to work with Worldpay to ensure that this report is set up correctly for your merchant account.
- DART reports are available for merchants on Worldpay's NAP platform. If you want to use DART reports, you need to work with Worldpay to ensure that your Worldpay merchant account is set up correctly.
Configuring Worldpay Gateway Reconciliation
To enable Worldpay gateway reconciliation, you need to configure the following gateway settings for Worldpay 1.4 or Access Worldpay based on your business needs:
- Enable gateway reconciliation: Select the Enable gateway reconciliation checkbox.
- Enable DART Reports for Reconciliation (Optional): Enable this setting if you want to use DART reports for reconciliation. With this check box selected, Zuora will retrieve DART reports from Worldpay.
- Enable Transfer Batch Report for Reconciliation (Optional): Enable this setting if you want to use the Transfer Batch report for reconciliation. With this check box selected, Zuora will retrieve the Transfer Batch report from Worldpay.
- Admin Code: Obtain the admin code that is set up by Worldpay and used for Worldpay Gateway reporting, and enter the code in this field. If you only use DART reports for reconciliation, you do not need to configure this setting.
- Merchant Acronym: Obtain the merchant acronym that will be used by Worldpay for reporting, and enter the acronym in this field. If you only use DART reports for reconciliation, you do not need to configure this setting.
No configuration is needed in your Worldpay merchant account. The Worldpay administrators will be informed with clear instructions on how to set up reporting for any merchants that will use the Zuora gateway reconciliation integration.
Gateway Reconciliation Reports
For the following reports, you must configure the Admin Code and Merchant Acronym fields correctly in the Worldpay gateway instance so that Zuora can look for the correct file names on the Worldpay server.
- WPG: The file name is in the
- PISCES/RECON: The file name is in the
- 505 EMIS: The file name is in the
- Chargeback: The file name is in the
- Transfer Batch: The file name is in the
For Data Analytics Reconciliation Tool (DART) reports, the Merchant ID configured in the Worldpay gateway instance must match the merchant ID that is posted by Worldpay in raw records or lines within the DART file. Worldpay will post transaction records for multiple merchants within the same DART report. Zuora will locate the correct records for a specific tenant by searching for the merchant ID.
DART reports are in the
WP_ZUOR_[DARTReportCode]_V03_[yyyymmdd]_[nnn].CSV format, where
nnn indicates the file sequence such as
DARTReportCode indicates transaction types. The DART report code can be one of the following values:
330CBK- Used for chargebacks.
312TRC- Used for payment and refund settlements, and payment rejections.
313PRC- Used for final settlements of records from 312. Only records under record type 5 are used for final settlement confirmation. These records are matched with records under record type 2 of the 312 file based on the party ID and settlement currency, then are marked as settled.
Best Practice to Use Worldpay Gateway Reconciliation
Worldpay only allows you to specify one main currency for your Worldpay account. All transactions on the gateway side will be converted to this currency. If the currency of the customer account in Zuora that determines the transaction currency does not match the currency of the Worldpay account, Worldpay Gateway Reconciliation will ignore the chargeback events. In this case, to have Worldpay Gateway Reconciliation working for different currencies, you need to:
- Create multiple Worldpay accounts for different currencies. Each account is dedicated for one currency.
- Configure multiple payment gateway instances in Zuora in correspondence with different Worldpay accounts.
- Assign payment gateway instances to customer accounts in different currencies. Ensure that the currency of a customer account is the same as the currency of the Worldpay account to which the Worldpay gateway instance is mapped.
The subsequent payment transactions that happen in one customer account will be sent and processed in the same currency.
Worldpay Gateway Reconciliation Limitations
Currently, the Worldpay gateway reconciliation has the following limitations:
- You cannot test Gateway Reconciliation for Worldpay in the Sandbox environment.
- To receive information on settlements and chargebacks from Worldpay reporting, a merchant must be using service level S, R, or M. The Transfer Batch Report is available only for level M merchants.
- The Worldpay report files will be posted to the Worldpay SFTP folder set up for the gateway reconciliation integration and remain for 7 days. Zuora needs to retry an unsuccessful job within the 7-day timeframe.
- The Order Number to be included in the EMIS report must be a string of 9 characters.
- Zuora supports SEPA transactions for Worldpay gateway reconciliation, but does not support mandate events.
- For chargeback reconciliation, only the same currency pairs (the payment currency same as the settlement currency) are supported.
- Chargeback is supported for C, M, and S level merchants. Note that the Transfer Batch report that supports processing chargebacks for M level merchants is an Early Adopter feature.
- Limitations for the support for DART reports:
- For the DART 330 report, only the same currency pairs are supported for chargeback events.
- DART 312 and 313 reports work as a pair for settlement events. If a matching 313 file is not found on the server on the same day or the 313 file does not contain final settlement confirmation for any settlement records from the matching 312 file from that day, those records will not be processed for settlement.
- Zuora does not support refund rejection events.