Read the wallet statement

The workspace's wallet statement, exactly as the merchant dashboard reads it: the movements newest first, each with the balance it left behind and what it was about, and per currency the window's opening and closing balance with its credits and debits. Balances always count every movement; with a type filter the lines and totals cover only the matching movements. A value the statement cannot read is 400. Requires the wallet.read scope.

Paging: limit is a ceiling, not a promise. Because every line must carry an exact balance, a type-filtered page also walks the movements hidden between the lines it shows, and it walks at most 10,000 of the workspace's movements for one page; when the shown lines lie further apart than that, the page ends early at its last line within reach and next carries on from exactly there. A page may therefore return far fewer than limit items — even a single one — while next is still set, and every figure on it is still exact. Follow next until it is absent, and never treat a short page as the end of the statement. A page with no type filter fills to limit while movements remain.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
currency
array of strings
length ≤ 10

A wallet currency to read (three letters, any case). Repeatable, at most ten; none reads every wallet.

currency
type
array of objects
length ≤ 20

A movement code to narrow the lines to. Repeatable, at most twenty; none shows every movement. other is not a filter.

type
date-time

The window's start, inclusive. Defaults to 30 days before the window's end.

date-time

The window's end, exclusive; leave it out to keep the window open up to now. The window must end after it starts and span at most 366 days.

string
^[A-Za-z0-9_-]{32}$

The next value of the previous page, to read the next (older) page.

integer
1 to 200
Defaults to 50
Headers
string
length ≤ 128
^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

string
enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json