Retrieve information from a Batch Gateway Reconciliation job
Use the instructions in this article to view a Batch Gateway Reconciliation job and retrieve information for your needs.
Zuora strongly recommends that you enable the Gateway Reconciliation Job Completion | Reconciliation Completed notification when you are using the Gateway Reconciliation feature. You will get notified when a Gateway Reconciliation job is completed or encounters an error. See Edit a Notification for more information.
Retrieve Gateway Reconciliation job information
- Navigate to Payments and select the Gateway Reconciliation.
The Gateway Reconciliation page lists the following information:
| Column Name | Description |
|---|---|
| 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. If no file is returned because the file on the gateway side is not ready for retrieving, the "Source Not Present" message is displayed in this column. Zuora incorporates a retry mechanism to fetch the Gateway Reconciliation file from the gateway server. If the file is not available on the gateway server at the time of the fetch, the "Source Not Present" message is displayed. Once the file is available on the gateway server, Zuora fetches and processes it. Note that processing the file may take time, so "Source Not Present" may still appear in Zuora temporarily, even if the file is already available on the gateway server. |
| Status |
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. |
- Click on the Job Number from the Gateway Reconciliation page to view the job details.
The gateway reconciliation job detail page provides the following information:
Basic Information
| Job Field | Description |
|---|---|
| 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 History
| Job Field | Description |
|---|---|
| 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. |
| Result |
The result of the attempt.
|
| Reason | Only provided when the attempt fails, giving the reason for the failure. |
Recover from a failed Gateway Reconciliation job
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:
- Zuora could not connect to the gateway to retrieve the source information. This can happen, if for example, the credentials were incorrect.
- Zuora was able to connect, but could not find the source settlement report, perhaps because the automatically generated source file name was wrong for some reason.
- Zuora connected and retrieved the file, but could not parse it. This can happen when the source file is created manually for testing, rather than by a well defined automatic process.
Zuora incorporates a retry mechanism to fetch the Gateway Reconciliation file from the gateway server. If the file is not available on the gateway server at the time of the retry, the "Source Not Present" message is displayed. This message indicates that the file has not yet been uploaded to the gateway server and is an expected behavior to handle cases where gateways upload files at varying times. Once the file is available on the gateway server, Zuora fetches and processes it. Note that processing the file may take time, so "Source Not Present" may still appear in Zuora temporarily, even if the file is already available on the gateway server.