v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB

Payouts

List Payout Requests

List all payout requests for the account.

get/api/{account}/payouts/payout-requests

Query parameters

limitstring

Number of payout requests to return

offsetstring

Number of payout requests to skip for pagination

Response

Example response

{
  "data": {
    "list": [
      {
        "invoiceId": "123",
        "createdAt": "2025-01-01T01:01:01+00:00",
        "amount": 123,
        "currency": "USD",
        "state": "new",
        "rejectReason": null
      }
    ],
    "marker": 123
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999844,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 1000,
      "limit_day": 50000,
      "remaining_minute": 999,
      "remaining_day": 49848
    }
  }
}