Payouts

List Payouts

Lists payouts (withdrawal requests) for an account or user, most recent first. Pass exactly one of account_id (a biz_ identifier) or user_id (a user_ identifier). The saved payout method on each payout additionally requires the payout:destination:read scope and is null without it.

get/payouts

Query parameters

account_idstring

The owning account ID (a biz_ identifier). Provide this or user_id.

user_idstring

The owning user ID (a user_ identifier). Provide this or account_id.

currencystring

Optional currency code filter, for example usd.

firstinteger

Number of payouts to return from the start of the window.

afterstring

Cursor to fetch the page after (from page_info.end_cursor).

lastinteger

Number of payouts to return from the end of the window.

beforestring

Cursor to fetch the page before (from page_info.start_cursor).

Response

payout method nulled without the destination-read scope

Changes