List Payouts

GET /v1/payouts?offset=0&limit=5

Overview

Retrieves a paginated list of payouts. This endpoint allows filtering by offset and limit to manage the number of results returned.

Authorization

• Header: Authorization: Bearer sk_test_907...de66

Request Details

Request

cURL

curl "https://api-prod.paybytoken.io/v1/payouts?offset=0&limit=5" \
  -X GET \
  -H "Authorization: Bearer sk_test_907...de66"

Request Parameters

Parameter	Type	Description
offset	integer	The number of items to skip before starting to collect the result set (e.g., 0).
limit	integer	The maximum number of items to return (e.g., 5).

Response Details

Response

The response returns a PayoutList object containing the total count and a list of payout details.

Attributes

Attribute	Type	Description
total	integer	Total number of payouts available.
data	array of objects	List of payout objects with their details.

Example Response

Success

{
  "total": 1,
  "data": [
    {
      "id": "pout_t24cg6MLdv1PgUiO",
      "account_id": "acct_1",
      "chain": "base",
      "amount": "5.0",
      "currency": "USDC",
      "destination_address": "0xB3906750209897ee480AcfA6cE64538ED0dB5A42",
      "metadata": null,
      "status": "succeeded",
      "payout_type": "manual",
      "requires_approval": 0,
      "tx_hash": "0x26cd67e2959c40b4f7257a0c12d0a5c08151bef0f10e71bf8985d4fb23274d49",
      "error_message": null,
      "created_at": "2025-09-05T14:04:55.000Z",
      "updated_at": "2025-09-05T14:05:10.000Z"
    }
  ]
}