Page through withdrawals

get

https://myapi.xegora.com/api/v1/withdrawals/page

One page of the workspace's withdrawals, newest first, optionally in one status, with how many match in all. Requires the wallet.read scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

enum

Exactly one withdrawal status name, in any letter case and with surrounding spaces ignored. Anything else is 400 invalid_request: a number, a comma-separated list (Requested,Paid), two names separated by a space, or a name that is not a withdrawal status — the same rule the order list applies to its status. Leave it out to read every status.

Allowed:

offset

integer

0 to 100000

Defaults to 0

limit

integer

1 to 100

Defaults to 50

Headers

X-Correlation-Id

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.

X-Language

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200A page of withdrawals.

400The request is malformed (code = invalid_request): a bad parameter or header, a missing or malformed Idempotency-Key, or a body member the contract does not have — named, by its path in the body, in errors. Do not retry unchanged.

401No valid API key (code = unauthorized): missing, malformed, unknown, revoked or expired, or a wrong secret. The message is worded for an API key — this surface has no session to sign in to.