This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.
Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway. For example, if Zuora processed 200 transactions through a gateway, you should see the same number of transactions on the gateway's reconciliation report, sometimes also called the settlement report.
A settlement report usually includes events from the following three stages of a payment's lifecycle:
Zuora Gateway Reconciliation feature supports retrieval and recording of gateway's payment processing, settlement, and post-settlement events, to aid in the gateway reconciliation efforts.
Gateway Reconciliation only applies to the gateway state of the payment or refund transaction. Cash Reconciliation is the actual financial information of the amount that was settled, the fees charged, and potential currency exchange performed. Cash reconciliation is not supported at this time.
Most gateways produce settlement reports on a daily basis. Zuora follows the schedule appropriate for each gateway, which is usually daily, and retrieves the appropriate gateway reconciliation report for processing in a job. Within a reconciliation job, every record in the report is parsed into an event and matched with the corresponding Zuora transaction. Zuora then takes the appropriate action based on the event information received and logs it. The following table lists the event types and the actions taken for each event:
|Successful Settlement||Zuora updates the Gateway State to "Settled" and the Settled On date field of a Payment transaction.|
|Settlement Error|| |
|Post-Settlement Exception|| |
Optionally, Zuora creates an External Refund with the Reason Code set to "Payment Reversal"
|Unknown Event||Zuora just logs the event and does not take any action.|
To use gateway reconciliation, you have to add and configure a gateway appropriately, by navigating to Z-Payment Settings > Setup Payment Gateway.
Gateway reconciliation is currently supported by the following gateways:
The Gateway Reconciliation page lists the following information:
|Job Number||The number assigned to the job for a particular reconciliation period.|
|Period Start||This is the earliest date for which reconciliation events are expected for this job.|
|Period End||This is the latest date for which reconciliation events are expected for this job.|
|Gateway Name||The name of the gateway for which the source information will be retrieved.|
|Source Name||The source from which the reconciliation report information will be retrieved. For example, the file name of the gateway settlement report.|
The status of the reconciliation job.
|Last Attempt On||The last time the system attempted to retrieve source information from the gateway.|
|Completed On||The time indicating when the job completed.|
The gateway reconciliation job detail page provides the following information:
|Status||The status of the reconciliation job.|
|Creation Date||Time when the job was created.|
|Period Start||The period of time in which reconciliation started for this particular job.|
|Period End||The period of time in which reconciliation ended for this particular job.|
|Gateway Type||The type of gateway used.|
|Gateway Name||The name of the gateway from which the source information will be retrieved.|
|Attempt||The number times the job has been submitted. If the initial attempt fails, the system will not retry automatically. The retrieval can be retried manually.|
|Start Date||Date when the attempt has started.|
|End Date||Date when the attempt ended.|
|Source Name||The name of the reconciliation report that is being retrieved.|
The result of the attempt.
|Reason||Only provided when the attempt fails, giving the reason for the failure.|
If the initial attempt to retrieve a gateway reconciliation report fails, the job's Status will say Error. Jobs can fail for a variety of reasons. The following is a list of common errors:
Once the first job attempt fails, Zuora will not retry retrieving the report. However, you have three options in which to retrieve the report:
Simply retries retrieving the report using the same default job information.
|Retry Upload File|| |
Retries retrieving the report by allowing an upload of a file from your local directory.
|Retry File Name|| |
Retries retrieving the report using the specified file/source name.