Skip to main content
GET
List pending payouts

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Query Parameters

limit
integer
default:25

Page size (default 25, max 100).

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

Opaque pagination cursor from a prior response's nextCursor.

programId
string
creatorId
string
minAmount
number
default:0

Minimum amount filter in dollars (default 0).

sortBy
enum<string>
default:amount
Available options:
amount,
dueDate,
creator
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of pending payouts.

nextCursor
string | null
required
hasMore
boolean
required
data
object[]
required
summary
object

Aggregate totals for the queried ledger window.