Skip to main content
GET
List Payouts

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Scopes

payouts:read

Query Parameters

limit
integer
default:50

Number of records to return.

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

Number of records to skip.

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

Optional exact withdrawal status filter.

Available options:
requested,
pending,
processing,
approved,
rejected,
completed,
failed
reference
string

Return only the payout you created with this reference. Matches exactly. A reference is unique on your account, so items holds at most one payout, and is empty with total 0 when none matches. A value with characters a reference cannot hold (anything but letters, digits, ., - and _) returns 400 with VALIDATION_ERROR.

Maximum string length: 128
Pattern: ^[A-Za-z0-9._-]{1,128}$

Response

Success - Payout list retrieved

Response containing paginated list of payouts/withdrawals

total
integer

Total number of payouts matching the query criteria, across all pages.

Example:

45

items
object[]

Array of payout objects for the current page