Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID (unique identifier for the business)

Query Parameters

completed_at_end
string<date-time>

Filter payouts completed to this date/time

completed_at_start
string<date-time>

Filter payouts completed from this date/time

external_id
string

Filter by external ID (partial match, case-insensitive)

max_amount
integer

Maximum payout amount in cents

min_amount
integer

Minimum payout amount in cents

page
integer

Page number (1-indexed, default: 1)

page_size
integer

Number of items per page (default: 20, max: 100)

processor
string

Filter by payment processor (stripe, adyen, paypal, etc.)

reconciliation_status
string

Filter by reconciliation status (unreconciled, partially_reconciled, fully_reconciled)

Search by external_id, reference_number, memo, or processor_payout_id

status
string

Filter by payout status

Response

count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required