Skip to main content
GET
List Payouts
Returns the account’s payouts, newest first. There are no sort parameters. List items are not the same shape as Get Payout: each item nests the full beneficiary and payout_destination objects instead of their ids, and it carries no account_id (every item belongs to the account in the path). Voided payouts are Hop reversals of completed payouts, hidden by default so the list totals match what left the account; pass status=voided to list them. cancelled and returned payouts are included by default. Requires an API key with read access on the payments scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)

Query Parameters

string
Filter by payout status: pending, pending_approval, processing, completed, failed, cancelled, returned or voided. When omitted, every status except voided is returned.
string
Filter by currency code: a supported fiat code (for example USD, EUR, GBP) or one of USDC, USDT
string
Return only payouts funded by this virtual account (starts with va_, and must belong to this account). An unknown or foreign id returns 404, not an empty page. There is no filter for withdrawals alone; select on funding_source.type client-side.
string
Filter payouts created on or after this date (ISO 8601, inclusive)
string
Filter payouts created before this date (ISO 8601, exclusive)
integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)

Response

array
Payout objects, newest first, with nested beneficiary and destination details
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Errors

Request Example

Response Example