v11

latestOpenAPI 3.1.12026-08-03174162.0 MB

Payouts

List payouts with cursor-based pagination

Returns payout data with cursor-based pagination and optional full-text search via the query parameter.

get/payouts

Query parameters

mineboolean

When true, returns payouts from teams where the authenticated user has payout access (for example, payout.read or payout.write).

Example:true

teamIdstring

Filter payouts by specific team unique identifier. BREAKING CHANGE: Replaced promoterId filter.

eventIdstring

Filter payouts by specific event unique identifier. When provided, only returns payouts for this event.

Example:evt_01jps5cgsenjrazw6wswmyspa3

status'UPCOMING' | 'FAILED' | 'PROCESSING' | 'PAID' | 'CANCELLED'

Filter payouts by payment status. UPCOMING: scheduled but not yet processed, FAILED: failed processing and will retry, PROCESSING: currently being processed, PAID: successfully completed, CANCELLED: cancelled before completion.

Example:PAID

approval'PENDING' | 'APPROVED' | 'REJECTED'

Filter payouts by approval status. PENDING: awaiting approval, APPROVED: approved for processing, REJECTED: rejected and will not be processed.

Example:APPROVED

querystring

Optional search query to filter payouts by text fields. When provided, search-backed pagination is used.

Example:PAID venue:sydney

sort'createdAt'

Optional list sort field. Use createdAt to return newest or oldest payouts first.

Example:createdAt

direction'asc' | 'desc'

Sort direction for payout lists. Defaults to desc when sort is provided.

Example:desc

limitinteger

Maximum number of payouts to return per request (1-100, default: 20)

Example:20

cursorstring

Pagination cursor for continuing to fetch subsequent results. Use the cursor from the previous response to continue.

Example:eyJpZCI6InBheV8wMWpwczVjZ3NmdjJ3cmU2aGQwcmM0dzR0OCJ9

Response

beforestring nullable

Cursor for navigating backward in the result set. Omitted when there are no prior results.

afterstring nullable

Cursor for navigating forward in the result set. Omitted when there are no subsequent results.

limitnumber required

Maximum number of items to return in each result set

Example response

{
  "payouts": [
    {
      "id": "pyt_01jps5cgsfv2wre6hd0rc4w4t8",
      "createdAt": "2026-08-03T06:13:52.219Z",
      "updatedAt": "2026-08-03T06:13:52.219Z",
      "paidAt": "2026-08-03T06:13:52.219Z",
      "dueAt": "2026-08-03T06:13:52.219Z",
      "status": "PAID",
      "method": "MANUAL",
      "approval": "APPROVED",
      "frequency": "AFTER_EVENT",
      "structure": "DEFAULT",
      "transfers": [
        {
          "id": "xfr_01jq8s6c38f97w9yfrfcdhf47v",
          "createdAt": "2026-08-03T06:13:52.219Z",
          "kind": "TICKETS",
          "amount": 1000,
          "currency": "AUD",
          "feeCurrency": "AUD",
          "reference": "XYZ",
          "gateway": "AIRWALLEX",
          "gatewayId": "fe33fb0f-d9d8-47cd-8eef-6a19bd6223eb",
          "beneficiary": "My Bank Account",
          "beneficiaryId": "ben_01jps5cgse5n6mg1ymkew9tsfh",
          "status": "SCHEDULED",
          "settlementAmount": 3550,
          "settlementCurrency": "USD"
        }
      ],
      "deductions": [
        {
          "id": "pdn_01jq8s6c38f97w9yfrfcdhf47v",
          "createdAt": "2026-08-03T06:13:52.219Z",
          "updatedAt": "2026-08-03T06:13:52.219Z",
          "amount": -1000,
          "currency": "AUD",
          "description": "Legacy payout deduction",
          "gateway": "AIRWALLEX",
          "gatewayId": "fe33fb0f-d9d8-47cd-8eef-6a19bd6223eb",
          "beneficiary": "My Bank Account",
          "beneficiaryId": "ben_01jps5cgse5n6mg1ymkew9tsfh"
        }
      ],
      "price": {
        "net": 1000,
        "total": 1000,
        "gross": 1000,
        "base": 1000,
        "currency": "AUD"
      },
      "event": {
        "id": "evt_01jps5cgsenjrazw6wswmyspa3",
        "name": "Test Event",
        "slug": "test-event",
        "location": "Watson's EQ"
      },
      "timeline": [
        {
          "id": "tl_01jgxyz123abc",
          "createdAt": "2026-08-03T06:13:52.219Z",
          "kind": "CREATED",
          "description": "Payout was created after event settlement",
          "author": "System",
          "userId": "usr_01jps5cgsd4tzjghtnt45qnhn0",
          "externalId": "airwallex:transfer_abc123:completed"
        }
      ],
      "eventId": "evt_01jps5cgsenjrazw6wswmyspa3"
    }
  ],
  "before": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNqIn19",
  "after": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNkIn19",
  "limit": 20
}