Skip to main content
GET
List payouts

Authorizations

X-Auth-Client
string
header
required

Your workspace client id.

X-Auth-Secret
string
header
required

Your sandbox client secret. The playground accepts sandbox keys only, sends the secret straight from your browser to the API, and needs your IP on the key's whitelist. In your own integration, sign requests with HMAC instead of sending the secret.

Query Parameters

limit
integer
default:20

Page size; values above 50 are cut to 50, and values below 1 or not a number fall back to 20

Required range: 1 <= x <= 50
offset
integer
default:0

Rows to skip

Required range: x >= 0
status
enum<string>

Filter by status, case-insensitive

Available options:
quote,
initiated,
pending,
pending_address_deposit,
processing,
success,
failed,
expired,
underpayment
from_asset
enum<string>

Filter by source asset, case-insensitive

Available options:
btc,
usdt,
usdc,
ngn
to_currency
string

Filter by settlement currency, case-insensitive

source
enum<string>

Filter by source, case-insensitive

Available options:
offchain,
onchain
sort_field
enum<string>
default:created_at

Sort column

Available options:
created_at,
updated_at,
status,
amount,
settlement_amount,
from_asset,
to_currency
sort_direction
enum<string>
default:DESC

Sort direction

Available options:
ASC,
DESC
from_date
string<date-time>

Created at or after (RFC 3339); ignored if it does not parse

to_date
string<date-time>

Created at or before (RFC 3339); ignored if it does not parse

Response

OK

Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead.

success
boolean
required

true on success

timestamp
string<date-time>
required

When the response was written.

data
object

The payload; its shape is given per operation. Omitted when there is none.

error
object
message
string

Human-readable summary; omitted when empty.

request_id
string

Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support.