Skip to main content
GET
List payouts

Authorizations

DPoP
string
header
required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Query Parameters

limit
integer
default:20

Items per page. Maximum 100.

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

Opaque cursor returned by a previous list response. Omit for the first page.

status
enum<string>[]

Filter by one or more statuses. Repeat the param to pass multiple values.

Payout lifecycle state. See the How Anton Evaluates Payouts guide for the full state machine and integration guidance.

Available options:
created,
pending_screening,
screening_failed,
pending_approval,
approved,
processing,
sent,
completed,
failed,
returned,
cancelled,
manual_review,
velocity_blocked,
pending_engine_review
beneficiary_id
string
Pattern: ^ben_[a-zA-Z0-9]+$
instrument_id
string
Pattern: ^ins_[a-zA-Z0-9]+$
batch_id
string
Pattern: ^bat_[a-zA-Z0-9]+$
dest_currency
string

ISO 4217 three-letter currency code.

Pattern: ^[A-Z]{3}$
Example:

"USD"

reference
string

Exact-match filter on the merchant's reference field.

created_after
string<date-time>

RFC 3339 timestamp. Returns payouts with created_at >= this. RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

created_before
string<date-time>

RFC 3339 timestamp. Returns payouts with created_at <= this (inclusive upper bound — matches /v1/batches). RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

Response

Paginated list of payouts.

data
object[]
required

Array of results for this page. Element schema varies by endpoint.

has_more
boolean
required

Whether more results exist beyond this page.

next_cursor
string

Cursor for the next page. Present only when has_more is true.