Welcome to Zuora Product Documentation

Explore our rich library of product information

Batch Gateway Reconciliation on FiservIPG

This document provides guidelines for enabling and configuring batch gateway reconciliation on Fiserv IPG, including prerequisites, setup steps, and status mapping.

Prerequisites for enabling gateway reconciliation in Zuora

Before enabling gateway reconciliation in your Fiserv IPG gateway instance, complete the following tasks in your Fiserv IPG merchant account:

  • Download the reconciliation files provided by Fiserv IPG from the SFTP server.
  • Create report user credentials in the Fiserv IPG gateway to receive the settlement reports. The report user credentials will be entered in the Reconciliation Username and Reconciliation Password fields in the configuration page of the Fiserv IPG gateway instance. Report user credentials usually have the prefix report_ and are different from the credentials used for web service transactions.

Enable gateway reconciliation in Zuora

To enable batch gateway reconciliation:

  1. Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway.
  2. On the Configure Gateway Instance tab, click the Fiserv IPG Gateway instance for which you want to enable the Gateway Reconciliation service.
  3. On the Gateway Instance Configuration page, select Enable gateway reconciliation and configure the following credentials:
    • Reconciliation Username: SFTP username for the reconciliation.
    • Reconciliation Password: SFTP password for the reconciliation. This password expires every three months.

For more detailed information, see Set up and configure FiservIPG integration.

Status mapping

The following table describes how different transaction status is mapped to the corresponding gateway reconciliation event type:

Gateway FieldZuora Field
UNIQUE_TRAN_ID(lpgTransactionId)gatewayReferenceId
CUSTOM_DATAgatewaySecondReferenceId
TRAN_TYPENotMapped
TRAN_AMTAmount
TRAN_DATEeventDate
TRAN_STATreconciliationEventType
NotApplicablegatewayRawRecord
Not ApplicableattemptId
Not ApplicablecurrencyCode

Reconciliation files only contain records for successful payments. If a transaction record is not received in the reconciliation file, its gateway state will remain Submitted and will not automatically change to Settled.