Skip to main content
GET
List all crypto payouts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

source
string

The accountId of the custody account the payouts were sent from. Without this filter, a Digital Asset Accounts distributor key returns only payouts on the distributor's own entity. To list an end user's payouts, pass the accountId of the end user's custody account. The account must belong to the caller; otherwise the request fails with Source wallet not found.

Example:

"1000662322"

destination
string<uuid>

Universally unique identifier (UUID v4) for the destination. Filters the fetched payout results made to a specific destination. If not provided, payouts to all destinations are returned.

Example:

"54c1cbab-c419-450f-ad23-906fa03af7f0"

type
enum<string>[]

Destination type. Set to address_book to list crypto payouts; without it, crypto payouts may be omitted from the results.

Available options:
address_book
status
enum<string>[]

Queries items with the specified status. Matches any status if unspecified.

Status of the payout. Status pending indicates that the payout is in process; complete indicates it finished successfully; failed indicates it failed.

Available options:
pending,
complete,
failed
sourceCurrency
string

Queries items with the specified source currency amount.currency. Matches any source currency if unspecified. Takes an uppercase ISO 4217 alpha-3 fiat currency code, such as USD or EUR. The value is case-sensitive. Stablecoin codes such as USDC and EURC aren't accepted and return a 400 error.

Pattern: ^[A-Z]{3}$
Example:

"USD"

destinationCurrency
string

Queries items with the specified destination currency toAmount.currency. Matches any destination currency if unspecified. Takes an uppercase ISO 4217 alpha-3 fiat currency code, such as USD or EUR. The value is case-sensitive. Stablecoin codes such as USDC and EURC aren't accepted and return a 400 error.

Pattern: ^[A-Z]{3}$
Example:

"USD"

chain
enum<string>

Queries items with the specified chain. Matches any chain if unspecified. A blockchain that a given currency is available on.

Available options:
ALGO,
APTOS,
ARB,
ARC,
AVAX,
BASE,
BTC,
CELO,
CODEX,
ETH,
HBAR,
HYPEREVM,
INK,
LINEA,
NEAR,
NOBLE,
OP,
PLUME,
PAH,
POLY,
SEI,
SOL,
SONIC,
SUI,
UNI,
WORLDCHAIN,
XDC,
XLM,
XRP,
ZKS
Example:

"ETH"

from
string

Queries items created since the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

to
string

Queries items created before the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

pageBefore
string

A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

Example:

"def9520a-5280-4089-9b02-3c9ef8fc8514"

pageAfter
string

A collection ID value used for pagination. It marks the exclusive beginning of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

Example:

"bce1e961-bdb8-4983-a9c2-0b3fbc2614cf"

pageSize
integer

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If omitted, the collection will determine the page size itself.

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of payouts.

data
object[]