Skip to main content
GET
List Payouts for the current Business and environment
Agents: fetch this page as plain markdown at https://docs.usecleff.com/api-reference/payouts-list.md.

Authorizations

Authorization
string
header
required

Cleff API key, created in the dashboard under Settings → API keys

Query Parameters

limit
number
cursor
string
status
enum<string>

Only Payouts in this lifecycle state. It filters on state, not on the status field a Payout carries: settled is accepted, in_transit is not.

Available options:
pending_approval,
approved,
rejected,
disbursed,
failed,
returned,
canceled,
settled,
compliance_hold
updatedSince
string

ISO-8601 timestamp; only Payouts with updated_at >= updatedSince are returned. Designed for polling clients.

Response

payouts
object[]
required
next_cursor
object | null
required