Tizondocs
ReferenceRevenue

List payouts

GET
/v1/revenue/payouts

Every payout this account has asked for, newest first.

Authorization

ApiKey
AuthorizationBearer <token>

An account API key, sent as Authorization: Bearer tz_live_…. The prefix selects the mode: tz_test_ for sandbox, tz_live_ for real money.

In: header

Query Parameters

limit?integer

Maximum items to return.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor from a previous page.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/revenue/payouts"
{  "object": "list",  "has_more": true,  "next_cursor": "string",  "data": [    {      "id": "string",      "object": "payout",      "livemode": true,      "status": "pending",      "amount": {        "amount": 1450,        "currency": "USD"      },      "lightning_address": "string",      "payment_hash": "string",      "amount_sats": 0,      "failure_reason": "string",      "created_at": "2019-08-24T14:15:22Z",      "resolved_at": "2019-08-24T14:15:22Z"    }  ]}