Reconciliation: Download the Report

Related API Reference

🔗
API Reference: Download a client reconciliation report file

Overview

When the report status is GENERATED, download the file.

GET {API_BASE_URL}/reconciliation/api/v1/outgoing-reconciliation-files?key={KEY}&downloadPath={DOWNLOAD_PATH}&reconciliationId={REPORT_ID}
Authorization: Bearer {ACCESS_TOKEN}

Parameter	Required	Description
key	Yes	`s3Key` from the status response.
reconciliationId	Yes	`reportId` of the report, for example `OREC366168819952398336`.
downloadPath	No	`s3DownloadPath` from the status response. The file is found by `key` and `reconciliationId`, so you can omit it.

👍
The fileUrl field of the status response is a ready-made URL with all three parameters. Call it with your Authorization header instead of building the URL yourself.

Example

curl -L -o report.xlsx \
  "$API_BASE_URL/reconciliation/api/v1/outgoing-reconciliation-files?key=1234567890/Reconciliation_Report-2026-10-01_2026-10-07.xlsx&downloadPath=Reconciliation_Report-2026-10-01_2026-10-07.xlsx&reconciliationId=OREC366168819952398336" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

If the file name contains +, pass it URL-encoded as %2B (the s3DownloadPath value already has it this way).

Response

The API responds with 200 OK and the file in the body. The file name is in the Content-Disposition: attachment header.

Format	Content-Type
XLSX	`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
CSV	`text/csv; charset=utf-8`

Report Columns

The report contains one row per transaction. The default set of columns:

Column	Description
Transaction ID	Transaction identifier
Transaction Type	`PAYMENT`, `DISBURSEMENT` or `REFUND`
Processing Amount / Currency	Amount and currency processed
Processing Fee Amount / Currency	Fee amount and currency
Transaction Status	Current status of the transaction
Last Update Date & Time	When the transaction was last updated
Settlement Account ID / Name	Your Settlement Account
Client Reference Transaction ID	Your own identifier of the transaction
Payment Method	Payment method used

Errors

HTTP code	When it happens
400	A report with this `reconciliationId` is not found.
401	The `Authorization` header is missing or invalid.
403	The token has no access to the Settlement Account of the report.