Zuora Batch Gateway Reconciliation service
Zuora's Batch Gateway Reconciliation service processes daily settlement reports from gateways, matching events with transactions to update gateway states and log actions.
Most gateways produce settlement reports daily. Zuora follows the schedule appropriate for each gateway, which is typically daily, and retrieves the corresponding gateway reconciliation report for processing in a job. Within a reconciliation job, Zuora parses every record in the report into an event, matches it with the corresponding Zuora transaction, takes the appropriate action based on the event information, and logs the result.
Occasionally, more than one job runs in a single day, often because of Zuora releases. When a Zuora release occurs while a job is running, the job stops. After the release completes, Zuora resumes the interrupted Gateway Reconciliation job as a new job.
The Gateway Reconciliation feature supports the retrieval and recording of a gateway's payment processing, settlement, and post-settlement events to support gateway reconciliation. In Zuora, the Gateway Reconciliation service processes data for the gateway integration type configured with Gateway Reconciliation. If you have multiple gateway instances of the same gateway integration type, Zuora processes and logs reconciliation information for all of these gateway instances.
-
The Gateway Reconciliation job reconciles only payment or refund transactions that occurred within the past year.
-
Gateway Reconciliation applies only to the gateway state of the payment or refund transaction. Cash reconciliation refers to the actual financial information about the settled amount, the fees charged, and any currency exchange performed. Cash reconciliation is not supported at this time. Zuora does not support reconciliation of rejected refunds. Only settled refunds are supported for gateway reconciliation.
-
Support details for gateway reconciliation vary by gateway. For more information, see Zuora gateway integrations that support Gateway Reconciliation.
The following table lists the event types and the actions that Zuora takes for each event:
Event type | Action |
|---|---|
Successful Settlement | Zuora updates the Gateway State field to Settled and updates the Settled On date field of the payment transaction. |
Settlement Error |
|
Post-Settlement Exception |
Optionally, Zuora creates an external refund with the reason code set to Payment Reversal if the code is active in the Reason Codes list. Otherwise, Zuora creates an external refund with the reason code set to the default reason code in the list. Zuora provides a feature to disable payment reversal in Gateway Reconciliation chargeback events. When this feature is enabled, Zuora does not create an external refund when a Post-Settlement Exception occurs, and you must use your own logic to process the settlement events. This feature is disabled by default. Note:
This feature is in the Early Adopter phase. To request access to the feature, submit a request at Zuora Global Support. |
Unknown Transaction | Zuora logs the event and takes no action. |
Unmapped Event | Zuora logs the event and takes no action. |
You can also use the Payment Gateway Reconciliation REST API operations to reconcile payments and refunds.
To retrieve the value of the Gateway State field, you can use the Retrieve a payment API operation or the Payment Data Source Export. For more information about the Gateway State field, see Electronic Payment Processing.