v1
latestOpenAPI 3.0.02026-07-26117342409.6 KBPayout Groups
List Payout Groups
Retrieves a list of payout groups.
get/rewards/payout-groups
Query parameters
limitinteger
page_cursorstring
asset_typestring
When set, only payout groups for this asset type (e.g. "USDG", "PYUSD") are returned.
name_prefixstring
When set, only payout groups whose name starts with this prefix are returned (case-insensitive).
claimer_addressstring
When set, only payout groups with this claimer address are returned.
ledgerstring
When set, only payout groups for this ledger (network) are returned.
jurisdictionstring
When set, only payout groups for this jurisdiction are returned.
onchain_statusesstring[]
When set, only payout groups with one of these onchain statuses are returned.
min_balancestring
When set, only payout groups with a balance >= this value are returned (in business units, e.g. "1000.50").
Response
A successful response.