List Payout Groups
Retrieves a list of payout groups.
Authorizations
Paxos APIs use OAuth 2 with the client credentials grant flow.
Token URLs:
- Production: https://oauth.paxos.com/oauth2/token
- Sandbox: https://oauth.sandbox.paxos.com/oauth2/token
Learn more in the API credentials guide →
Query Parameters
When set, only payout groups for this asset type (e.g. "USDG", "PYUSD") are returned.
When set, only payout groups whose name starts with this prefix are returned (case-insensitive).
When set, only payout groups with this claimer address are returned.
When set, only payout groups for this ledger (network) are returned.
When set, only payout groups for this jurisdiction are returned.
When set, only payout groups with one of these onchain statuses are returned.
UNREGISTERED, PENDING_REGISTRATION, NEEDS_REREGISTRATION, ACTIVE, FAILED_REGISTRATION, PENDING_DELETION, FAILED_DELETION, PENDING_MULTIPLIER_UPDATE, MULTIPLIER_UPDATE_FAILED, UNREGISTERED_INSUFFICIENT_BALANCE When set, only payout groups with a balance >= this value are returned (in business units, e.g. "1000.50").