Version History
| Field | Description | Sample |
|---|---|---|
| 05/08/25 | Version 1 - ClosedBatchReport: This version enables merchants to retrieve complete batch-level information by passing either the TPN alone, or in combination with batch date and/or batch number. | v1/batch-report |
The Batch Report API retrieves detailed batch reports for closed batches using the Terminal Profile Number (TPN), Batch Number, and Batch Date.
The report includes the following:
| Field | Description |
|---|---|
| Batch Profiles | A list of all profiles included in this batch. Each profile includes terminal and processor configuration data and detailed transactions. |
| Cash Payments | Total value and count of cash-based transactions. |
| Alternative Payments | Total value and count of payments using alternate methods (e.g., ACH). |
| Batch Total | Total value of all transactions in the batch, including tips and fees. |
| Total Transactions | Count of all transactions included in the batch. |
| Batch Number | Unique identifier automatically assigned to each batch. |
| Total Tip | Cumulative tip amount collected across all transactions. |
| Total Fee | Combined fee charged across all transactions. |
| Total Without Fee | Total transaction amount before applying any fees. |
Prerequisites
For Sandbox (UAT)
Users should be onboarded on the iPOSpays sandbox (UAT) environment as a merchant and have a valid TPN.
For Production (Live)
Users should be onboarded on the iPOSpays production environment as a merchant and have a valid TPN.
If you do not have a TPN, contact your ISO or devsupport@dejavoo.io
Error Codes and Their Meaning
For a complete list of error codes and their explanations, please visit our Error Codes Reference Page.
Last updated on July 23, 2026