Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Payouts

Get payout preview for approvals

Returns lightweight payout split rows and beneficiary resolution status used by approvals dropdowns.

get/payouts/{id}/preview

Path parameters

idstring required

Unique identifier of the payout to retrieve.

Example:pyt_01jps5cgsfv2wre6hd0rc4w4t8

Query parameters

includeSettlementSummaryboolean

When true, includes the Airwallex settlement summary for the payout preview.

Example:true

Response

OK

Example response

{
  "payout": {
    "id": "pyt_01jps5cgsfv2wre6hd0rc4w4t8",
    "status": "PAID",
    "approval": "APPROVED",
    "method": "MANUAL",
    "frequency": "AFTER_EVENT",
    "structure": "DEFAULT",
    "createdAt": "2026-08-03T06:13:52.219Z",
    "dueAt": "2026-08-03T06:13:52.219Z",
    "eventId": "evt_01jps5cgsenjrazw6wswmyspa3",
    "event": {
      "id": "evt_01jps5cgsenjrazw6wswmyspa3",
      "name": "Test Event",
      "slug": "test-event",
      "location": "Watson's EQ"
    },
    "price": {
      "net": 1000,
      "total": 1000,
      "gross": 1000,
      "base": 1000,
      "currency": "AUD"
    }
  },
  "rows": [
    {
      "kind": "tickets",
      "amount": 114500,
      "currency": "AUD",
      "beneficiary": {
        "status": "VALID",
        "warning": "Using fallback beneficiary with matching gateway only.",
        "beneficiary": {
          "id": "ben_01jps5cgse5n6mg1ymkew9tsfh",
          "teamId": "tem_01jqpjksnsen9vprw95et60t2m",
          "name": "My Bank Account",
          "gateway": "AIRWALLEX",
          "gatewayId": "7489cb17-24c5-4acf-a0cf-d93ed38081fe",
          "currency": "AUD"
        }
      }
    }
  ],
  "settlementSummary": {
    "state": "TRACKED",
    "settled": {
      "orders": 12,
      "price": {
        "net": 500,
        "total": 1400,
        "gross": 2200,
        "base": 1000,
        "booking": 400,
        "sms": 200,
        "refunded": -700,
        "discount": -1000,
        "currency": "AUD"
      }
    },
    "awaitingSettlement": {
      "orders": 12,
      "price": {
        "net": 500,
        "total": 1400,
        "gross": 2200,
        "base": 1000,
        "booking": 400,
        "sms": 200,
        "refunded": -700,
        "discount": -1000,
        "currency": "AUD"
      }
    }
  }
}