Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Payouts

Update a payout

Update payout status or approval. Use approval field to approve or reject payouts.

patch/payouts/{id}

Path parameters

idstring required

Unique identifier of the payout to update.

Example:pyt_01jps5cgsfv2wre6hd0rc4w4t8

Request body

status'CANCELLED'

Optional new payment status for the payout. Only CANCELLED is allowed for manual updates.

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

Optional new approval status for the payout. PENDING: awaiting approval, APPROVED: approved for processing, REJECTED: rejected.

Example request

{
  "status": "CANCELLED",
  "approval": "APPROVED"
}

Response

OK

idstring required

A unique identifier for this payout.

createdAtstring date-time required

Timestamp in ISO 8601 format when this payout was created.

updatedAtstring date-time required

Timestamp in ISO 8601 format when this payout was last updated.

paidAtstring date-time

Timestamp in ISO 8601 format when this payout was completed.

dueAtstring date-time

Earliest timestamp in ISO 8601 format when this payout can be picked up for processing. This is not a guaranteed bank arrival time.

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

Current payment status of this payout.

method'AIRWALLEX' | 'STRIPE' | 'MANUAL' required

The payout channel used for disbursing funds.

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

Approval status for this payout.

frequency'DAILY' | 'WEEKLY' | 'AFTER_EVENT' | 'ON_DEMAND'

Schedule on which this payout is generated.

structurestring required

Data structure defining how funds are allocated in this payout.

eventIdstring required

Identifier of the event for which this payout was generated.

teamIdstring required

Team receiving this payout. BREAKING CHANGE: Replaced promoterId/promoterSlug.

Example response

{
  "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"
}