Settlement Report
Settlement Report
The settlement report is a bank-statement-style CSV of every credit and debit across your virtual accounts within a date range. Use it to reconcile deposits, payouts, sweeps and their reversals against your own records.
It is generated on demand: you request a report for a period, the file is built in the background, and you download it with a signed link once it is ready.
How it works
| Step | Endpoint | What happens |
|---|---|---|
| 1. Request | POST /wallet/v1/stats/account-movements-report | Send from and to (and optionally currency). Returns a jobId and status: PENDING. |
| 2. Poll | GET /wallet/v1/stats/account-movements-report/{jobId} | Check status. It moves PENDING → PROCESSING → COMPLETED (or FAILED). |
| 3. Download | same GET | When COMPLETED, the response includes fileUrl — a signed URL to download the CSV. |
fileUrl is short-lived (it expires after about 10 minutes) and is regenerated on every call, so request it again if your link expires. The company is resolved from your API key; you never pass a company ID.
CSV columns
One row per movement.
| Column | Description |
|---|---|
| Date | Date and time of the movement |
| Sub Type | Movement type (see below) |
| Account Address | The virtual account of yours that moved |
| Amount | Movement amount |
| Currency | Currency of the movement |
| Counterparty Name | Name of the other party |
| Counterparty Document | Tax/national ID of the other party |
| Counterparty Address | The other party's address — only on debits; blank on deposits |
| E2E ID | End-to-end payment identifier |
| Transaction ID | Identifier of the movement |
| Original Transaction ID | The reversed movement — only on reversals |
| Resulting Balance | Account balance after the movement |
Sub Type values
| Value | Meaning |
|---|---|
Deposit | Funds received into a virtual account |
Withdrawal | Funds sent out of a virtual account |
Reversal of Deposit | A returned/reverted deposit |
Reversal of Withdrawal | A returned/reverted withdrawal |
Sweep in | Funds moving into your master account from another virtual account |
Sweep out | Funds moving out of your master account to another virtual account |
A movement is a sweep when the counterparty is your master account — the account you pool funds into. Everything else is a regular deposit or withdrawal against an external party.
Updated 4 months ago