Reconciliation: Check the Report Status

Related API Reference

🔗
API Reference: Get the status of a client reconciliation report

Overview

After you request a report, poll its status using the reportId from the response.

GET {API_BASE_URL}/reconciliation/api/v2/outgoing-reconciliations/settlement-accounts/{SETTLEMENT_ACCOUNT_ID}/reports/{REPORT_ID}/status
Authorization: Bearer {ACCESS_TOKEN}

curl "$API_BASE_URL/reconciliation/api/v2/outgoing-reconciliations/settlement-accounts/SA1234567890/reports/OREC366168819952398336/status" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The {SETTLEMENT_ACCOUNT_ID} must be the account the report was requested for; otherwise the API returns 403.

Polling

Repeat the request every few seconds. Large periods take longer.
Stop when the status is GENERATED (success) or ERROR (failure).
Access tokens are valid for 30 minutes. If the token expires while you wait, refresh it and continue polling with the same reportId.

Response

While the report is being generated:

{
  "reportId": "OREC366168819952398336",
  "status": "GENERATION_STARTED",
  "s3Key": "",
  "s3DownloadPath": "",
  "fileSize": 0,
  "fileName": "",
  "fileUrl": "",
  "generationDate": "2026-10-08T05:12:41.318Z",
  "startDate": "2026-09-30T21:00:00Z",
  "endDate": "2026-10-07T20:59:59Z",
  "clientTimezone": "UTC+3",
  "generatedBy": "john.doe",
  "transactionTypes": ["PAYMENT"]
}

When the report is ready, the status is GENERATED and the file fields are filled in:

{
  "reportId": "OREC366168819952398336",
  "status": "GENERATED",
  "s3Key": "1234567890/Reconciliation_Report-2026-10-01_2026-10-07.xlsx",
  "s3DownloadPath": "Reconciliation_Report-2026-10-01_2026-10-07.xlsx",
  "fileSize": 48213,
  "fileName": "Reconciliation_Report-2026-10-01_2026-10-07.xlsx",
  "fileUrl": "{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",
  "generationDate": "2026-10-08T05:12:41.318Z",
  "startDate": "2026-09-30T21:00:00Z",
  "endDate": "2026-10-07T20:59:59Z",
  "clientTimezone": "UTC+3",
  "generatedBy": "john.doe",
  "transactionTypes": ["PAYMENT"]
}

Field	Description
reportId	Report identifier with the `OREC` prefix.
status	`GENERATION_STARTED`, `GENERATED` or `ERROR`. See statuses.
s3Key	File key. Pass it as `key` when downloading the file.
s3DownloadPath	File name for downloading.
fileSize	File size in bytes.
fileName	File name.
fileUrl	Ready-to-use download link. Call it with the same `Authorization` header.
generationDate	When the report was requested, in UTC.
startDate, endDate	Period boundaries in UTC, calculated from your `timezone`.
clientTimezone	Timezone of the report.
generatedBy	Who requested the report.
transactionTypes	Transaction types included in the report.

If the status is ERROR, request the report again. If the error repeats, contact support and give the reportId.

Errors

HTTP code	When it happens
403	The token has no access to the Settlement Account or the report.
404	A report with this `reportId` does not exist.