v1

latestOpenAPI 3.0.1MIT2026-07-26336777.7 KB

Retrieve a list of payouts created within a specific time range, with support for filtering and pagination. This endpoint allows you to track and analyse all payout transactions to your account. It's useful for building dashboards, reconciling payouts, or reviewing recent payout transactions programmatically.

get/balance/payouts

Query parameters

startTimeinteger

Start of range in epoch milliseconds. Fetches items created after this timestamp.

endTimeinteger

End of range in epoch milliseconds. Fetches items created before this timestamp.

limitinteger

Max items per page (default 10, max 100)

offsetstring

Cursor-based pagination token. Use the offset value from metadata.offset in the previous response to fetch the next page. Continue until metadata.offset is no longer present in the response.

🚨 Important: Changing any query parameters invalidates existing offset values and requires restarting pagination from the beginning.

For detailed pagination implementation guide, see Pagination Guide.

Response

Successful response with payouts and pagination cursor.

Example response

{
  "data": [
    {
      "amount": 30000,
      "status": "SUCCESS",
      "createdAt": 1727340330123
    }
  ]
}