Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-06-01"

Query Parameters

page
integer
default:1

Which page to return, counting from 1. This list pages by number, not by offset.

Required range: x >= 1
limit
integer
default:10

How many payouts to return. Between 1 and 100, and 10 when you omit it.

Required range: 1 <= x <= 100
status
string

Filter by payout status.

Available options: CREATED, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, IN_REVIEW, KYT_PENDING. See Payout values.

origin
string

Filter by what started the payout.

Available options: deposit, payout, api. See Payout values.

user_id
string<uuid>

Return only the payouts belonging to this user.

recipient_id
string<uuid>

Return only the payouts that went to this recipient.

virtual_account_id
string<uuid>

Return only the payouts that left this account.

from_date
string

Return only payouts created from this moment on. Send a full ISO 8601 timestamp or just a date as YYYY-MM-DD.

to_date
string

Return only payouts created up to this moment, included. Send a full ISO 8601 timestamp or just a date as YYYY-MM-DD, which covers that whole day.

Search the payouts. Matches part of the payout ID, part of the reference you set, or part of the user's or recipient's name. Also matches a tracking reference whole: the reference_number (an IMAD, an ACH trace number or a UETR), the uetr or the txn_hash, whatever its case. Up to 255 characters.

Maximum string length: 255
from_amount
string

Return only the payouts of this from_amount, what you paid, compared as a number: 2500.5 finds 2500.50. A plain decimal such as 2500.50, with no thousands separator. Greater than zero.

Pattern: ^(?!0+(\.0+)?$)\d{1,18}(\.\d{1,8})?$
Example:

"2500.50"

to_amount
string

Return only the payouts of this to_amount, what the recipient gets, compared as a number. A plain decimal such as 45000, with no thousands separator. Greater than zero.

Pattern: ^(?!0+(\.0+)?$)\d{1,18}(\.\d{1,8})?$
Example:

"45000"

sort_by
string

Which field to sort on.

Available options: created_at, from_amount, status. created_at when you omit it.

sort_order
string

Which way to sort.

Available options: asc, desc. desc when you omit it.

metadata
object

Return only the payouts carrying the metadata you name, in the ?metadata[key]=value form. Pass more than one key to require all of them.

Each key is 1 to 40 characters and cannot contain [ or ].

Response

Success.

payouts
object[]
total
integer

Total number of payouts matching the filters.

page
integer

The page returned.

limit
integer

The limit applied to this page.

total_pages
integer

How many pages the filters produce at this limit.