APG PayAPG Paydocs

Payouts

Get payout

GET/payouts/{payoutId}
Request
GEThttps://api.tst.au.apgpay.dev/payouts/{payoutId}
curl -X GET https://api.tst.au.apgpay.dev/payouts/{payoutId} \
  -H "Authorization: Bearer $API_KEY"

Return one payout, with what it is made of.

Permissions

Required permission
merchantFinancials:query

Requires the `query` action on `merchantFinancials` for the supplied runtime context

Path parameters

payoutIdstring
required

Responses

The response is a tagged shape: type is always "PayoutViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "PayoutViewAttributes"
payoutIdPayoutIdrequired

Identifier of a payout.

Example payout_9f2Kd8QpLzXw

referencestring

The reference the merchant sees, and the one that appears against the deposit. Set once the payout is raised.

Example your-own-reference

merchantIdMchtIdrequired

Identifier of a merchant.

Example mcht_9f2Kd8QpLzXw

marketplaceIdMktpId

The marketplace that merchant trades under, where it does.

Example mktp_9f2Kd8QpLzXw

enterpriseIdEntIdrequired

Identifier of an enterprise.

Example ent_9f2Kd8QpLzXw

statusPayoutStatusrequired

Where the payout is up to. This is the external status: a payout being retried reads as InTransit, not Pending.

CreatedPendingInTransitPaidCanceledFailedReversedSuspendedUnknown

What the payout moved, and the merchant's balance either side of it. All in the single currency given here.

entryCountinteger (int64)required

How many journal entries were rolled into this payout, excluding the payout entry itself.

Example 42

When and how the payout settles.

Whether the platform raised this payout on a schedule or someone asked for it.

How the payment carrying this payout is going, or went.

externalAccountIdXaccId

The bank account the payout was sent to. Absent where the payout is not disbursed by the platform.

Example xacc_9f2Kd8QpLzXw

Which stretch of the merchant's ledger this payout cleared. This is what makes a payout reproducible from the books.

statementDescriptorstring

What the merchant asked to appear on the recipient's bank statement.

Example ADA COFFEE

narrativestring

Internal notes on what the payout contains. Operational, not merchant-facing.

What the payout is made of, by entry type. Present on a by-id read; a page of payouts is not rolled up.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "PayoutViewAttributes",
  "payoutId": "payout_9f2Kd8QpLzXw",
  "reference": "your-own-reference",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "marketplaceId": "mktp_9f2Kd8QpLzXw",
  "enterpriseId": "ent_9f2Kd8QpLzXw",
  "status": "Created",
  "amounts": {
    "type": "PayoutAmountsAttributes",
    "currency": "AUD",
    "amount": 1250,
    "openingBalance": 1250,
    "closingBalance": 1250
  },
  "entryCount": 42,
  "settlement": {
    "type": "PayoutSettlementAttributes",
    "settlementType": "Net",
    "facilitation": "Abacus",
    "settlementDate": "2026-08-19",
    "arrivedAt": "2026-08-19T04:21:07Z"
  },
  "origin": {
    "type": "PayoutOriginManual",
    "issuedBy": "string"
  },
  "disbursement": {
    "type": "PayoutDisbursementAttributes",
    "disbursementId": "disb_9f2Kd8QpLzXw",
    "gateway": "StripeConnectAu",
    "priority": 10,
    "channel": "DirectEntry",
    "requestedChannels": [
      "DirectEntry"
    ],
    "required": true,
    "attempts": [
      {
        "type": "PayoutAttemptCleared",
        "disbursementId": "disb_9f2Kd8QpLzXw",
        "at": "2026-08-19T04:21:07Z"
      }
    ]
  },
  "externalAccountId": "xacc_9f2Kd8QpLzXw",
  "ledgerClearance": {
    "type": "PayoutLedgerClearanceAttributes",
    "systemLedgerId": "string",
    "firstSequence": 1250,
    "lastSequence": 1250
  },
  "statementDescriptor": "ADA COFFEE",
  "narrative": "string",
  "composition": {
    "type": "PayoutCompositionAttributes",
    "currency": "AUD",
    "journalEntries": [
      {
        "type": "PayoutEntrySummaryAttributes",
        "entryType": "string",
        "count": 42,
        "amount": 1250
      }
    ],
    "ledgerEntries": [
      {
        "type": "PayoutEntrySummaryAttributes",
        "entryType": "string",
        "count": 42,
        "amount": 1250
      }
    ]
  },
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses