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

StepEndpointWhat happens
1. RequestPOST /wallet/v1/stats/account-movements-reportSend from and to (and optionally currency). Returns a jobId and status: PENDING.
2. PollGET /wallet/v1/stats/account-movements-report/{jobId}Check status. It moves PENDING → PROCESSING → COMPLETED (or FAILED).
3. Downloadsame GETWhen 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.

ColumnDescription
DateDate and time of the movement
Sub TypeMovement type (see below)
Account AddressThe virtual account of yours that moved
AmountMovement amount
CurrencyCurrency of the movement
Counterparty NameName of the other party
Counterparty DocumentTax/national ID of the other party
Counterparty AddressThe other party's address — only on debits; blank on deposits
E2E IDEnd-to-end payment identifier
Transaction IDIdentifier of the movement
Original Transaction IDThe reversed movement — only on reversals
Resulting BalanceAccount balance after the movement

Sub Type values

ValueMeaning
DepositFunds received into a virtual account
WithdrawalFunds sent out of a virtual account
Reversal of DepositA returned/reverted deposit
Reversal of WithdrawalA returned/reverted withdrawal
Sweep inFunds moving into your master account from another virtual account
Sweep outFunds 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.


Did this page help you?