Skip to main content
GET
List payouts
Requires scope: manage:pay-outs — see Required scopes. Lists the account’s pay-outs — both PULL (created via the API) and PUSH (created from an observed customer deposit), distinguished by fundingMode. Returns compact summaries: the nested payoutRoute is route-only, with no beneficiary and no deposit address. Use Get a payout for the full shape.
sortOn accepts only createdAt, status and cryptoAmount. Any other value returns 400.

Authorizations

Path Parameters

accountId
string<uuid>
required

Unique account identifier

Query Parameters

status
enum<string>

Restrict the list to a single payout status Pay-out lifecycle. The PULL happy path is REQUESTED → SENDING → PROVIDER_PROCESSING → COMPLETED; PUSH pay-outs start at PROVIDER_PROCESSING. Note that a fiat leg can still bounce after completion (COMPLETED → RETURNED).

  • REQUESTED — created via the API; awaiting dispatch of the managed send leg. PULL only
  • SENDING — the managed on-chain send is in flight. PULL only
  • PROVIDER_PROCESSING — funds reached the provider deposit address; awaiting the fiat pay-out
  • COMPLETED — the provider reported the fiat pay-out as completed; settledFiatAmount is set
  • REJECTED — request validation failed before dispatch. PULL only. Terminal
  • FAILED — the managed send leg failed terminally. PULL only. Terminal
  • RETURNED — the provider reported the fiat leg as bounced or returned. Terminal
Available options:
REQUESTED,
SENDING,
PROVIDER_PROCESSING,
COMPLETED,
REJECTED,
FAILED,
RETURNED
page
integer<int32>
default:1

Page number (1-based indexing)

Required range: x >= 1
size
integer<int32>
default:100

Number of items per page

Required range: x >= 1
sortOn
string
default:createdAt

Field to sort by

sortOrder
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC

Response

Paginated list of payout summaries. Empty for pages beyond the data or filters with no matches.

success
boolean

Indicates whether the request was successful

result
object[]
pagination
object

Pagination metadata (top-level sibling of result)