Anton.Docs
Dashboard (opens in a new tab)

List payouts

GET/v1/payouts
The request matches the contract.

Parameters

string · query
Items per page, 1 to 100. A value outside that range returns `400 invalid_limit`.
string · query
Opaque cursor returned by a previous list response. Omit for the first page.
string · query
Filter by one or more statuses. Repeat the parameter to pass several.
string · query
Only payouts to this beneficiary (`ben_...`).
string · query
Only payouts to this instrument (`ins_...`).
string · query
Only payouts created by this batch (`bat_...`).
string · query
Only payouts debited in this currency (uppercase code, for example `USD`).
string · query
Only payouts delivered in this currency (uppercase code, for example `EUR`).
string · query
Exact-match filter on your `reference`.
string · query
RFC 3339 timestamp. Returns payouts with `created_at` at or after it. It must be RFC 3339 UTC with millisecond precision and a Z suffix, suc
string · query
RFC 3339 timestamp. Returns payouts with `created_at` before it. It must be RFC 3339 UTC with millisecond precision and a Z suffix, such as