Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Query Parameters

limit
integer

Page size, 1-200 (default 50).

Required range: 1 <= x <= 200
before_id
string<uuid>

Keyset cursor: the next_before_id from the previous page.

asset
string

Only payouts in this asset.

Minimum string length: 1
Example:

"USDC"

status
enum<string>

Only payouts in this status.

Available options:
received,
validated,
held,
submitted,
pending,
succeeded,
failed,
reversed

Response

One page of payouts.

payouts
object[]
required
has_more
boolean
required
next_before_id
string<uuid> | null
required

Pass back as before_id for the next page; null means done.