Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Payouts

Add note to payout timeline (`payout.write` required)

Add a user note to the payout timeline. Note will be marked as editable by the author.

post/payouts/{id}/notes

Path parameters

idstring required

Unique identifier of the payout to add a note to

Example:pyt_01jps5cgsfv2wre6hd0rc4w4t8

Request body

notestring required

Note text content (1-1000 characters)

Example request

{
  "note": "Transfer confirmed via bank statement"
}

Response

OK

Example response

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