Reconciliation Files

This endpoint allows you to download a reconciliation file containing all transactions for a specific period and status. The file can be exported in CSV or TXT format, and includes detailed information for backend validation, accounting, or audits.

Retrieve files

Returns a reconciliation file with a list of all transactions filtered by date range and status. The file includes key data fields such as UUID, amounts, currencies, statuses, and timestamps. By default, the reconciliation file includes transactions in all possible order statuses.

GET https://stage.api.payments.depay.us/v2/reports/reconciliation

Headers

Name	Type	Description
Authorization*	String	Bearer Token.

Query Parameters

Name	Type	Required	Description
start_date	String	No	Start date for the report (format: YYYY-MM-DD).
end_date	String	No	End date for the report (format: YYYY-MM-DD).
status	String	No	Filter by transaction status (e.g., CREATED, COMPLETED, CANCELED).
format	String	Yes	File format: csv (default) or txt.

Fields in the reconciliation file:

Field	Type	Description
Transaction Type	String	Type of transaction being processed (e.g., closed_amount, open_amount).
Date	Datetime	Date and time the payment was processed (ISO 8601 format).
Order Id	String	Unique identifier assigned by Depay to the order.
External Reference	String	Custom reference provided by the merchant for internal tracking.
Customer	String	Internal customer identifier linked to the transaction.
Collector Name	String	Registered name of the collector receiving the payment.
Collector Identification Number	String	Tax ID or legal identifier of the collector or business.
Collector Account	String	Bank account number where funds are settled for the collector.
Collector Bank	String	Name of the bank where the collector's account is held.
Status	String	Status of the transaction (e.g., COMPLETED, REFUNDED, PARTIALLY_REFUNDED).
Customer Defined Fee	Decimal	Fee amount set or charged by the merchant to the customer.
User Fee Amount	Decimal	Fee amount paid by the user.
User Amount	Decimal	Amount paid by the user in their original currency.
User Currency	String	Currency code representing the user’s payment currency (e.g., ARS, BRL).
User Country	String	ISO 3166-1 alpha-2 country code of the user's country (e.g., AR, BR, US).
User Name	String	Full name of the user making the payment.
User Account Number	String	Bank or virtual account number used by the user.
User Tax ID	String	Tax identifier or document number of the user (e.g., CPF, CUIT, SSN).
Amount USD	Decimal	Payment amount expressed in USD for reference.
Local Amount	Decimal	Amount to be received by the merchant in the local currency.
Local Currency	String	Currency code representing the local currency (e.g., ARS, BRL).
Local Country	String	ISO 3166-1 alpha-2 country code of the merchant’s country (e.g., AR, BR, US).

Refunded Orders in the Reconciliation File

When an order transitions to REFUNDED, all COMPLETED orders will appear first in the .csv file. Refund orders will be listed at the end of the file, sorted by date and time, following the same ordering rules as COMPLETED orders.

Each refund generates a separate entry in the file. For example, if there is a COMPLETED order for 10 USD followed by two partial refunds of 4 USD each and a final full refund, the entries will appear as follows:

• COMPLETED order — 10 USD

• PARTIALLY_REFUNDED — 4 USD

• PARTIALLY_REFUNDED — 4 USD

• REFUNDED — remaining amount

Note: Such cases are very rare. In most situations where there is a partial refund, there will not be more than one partial refund entry.

200: OK

File: 2025-04-07-conciliation.csv
Content-Type: text/csv

400: Bad Request

401: Unauthorized Permission Denied

409: Conflict Error