APG PayAPG Paydocs

Payouts

List payouts

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

Return a page of payouts. Filter by reference to answer a question about a bank statement line. composition is not populated on a page. The filters combine with each other and with q by AND. GET /filter-catalogues/payouts lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400. One issued before the list named its walks resumes as it did.

Permissions

Required permission
merchantFinancials:query

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

Query parameters

qstring

Search. Matches a payout id, the reference payout id, the statement descriptor or the narrative. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

sortarray of PayoutSort

Fields to sort by, comma-delimited, in priority order. Prefix a field with - for descending.

columnsarray of PayoutColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

statusone of PayoutStatus, array of PayoutStatus

Only payouts whose status is one of these. Repeat the parameter to give several.

payoutIdone of array of string, string

Only payouts whose payout is one of these. Repeat the parameter to give several.

merchantIdone of array of string, string

Only payouts whose merchant is one of these. Repeat the parameter to give several.

marketplaceIdone of array of string, string

Only payouts whose marketplace is one of these. Repeat the parameter to give several.

enterpriseIdone of array of string, string

Only payouts whose enterprise is one of these. Repeat the parameter to give several.

referenceone of array of string, string

Only payouts whose reference is one of these. Repeat the parameter to give several.

disbursementIdone of array of string, string

Only payouts whose disbursement is one of these. Repeat the parameter to give several.

currencyone of IsoCurrency, array of IsoCurrency

Only payouts whose currency is one of these. Repeat the parameter to give several.

amountFrominteger (int64)

Only payouts whose amount, in minor units of currency, is at least this.

amountTointeger (int64)

Only payouts whose amount, in minor units of currency, is at most this.

settlingFromstring (date)

Only payouts whose settlement date is at or after this ISO-8601 date.

settlingTostring (date)

Only payouts whose settlement date is at or before this ISO-8601 date.

createdAfterstring (date-time)

Only payouts whose creation time is at or after this ISO-8601 timestamp.

createdBeforestring (date-time)

Only payouts whose creation time is before, and not at, this ISO-8601 timestamp.

Responses

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

Discriminated by type
type = "PayoutPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "PayoutPageAttributes",
  "data": [
    {
      "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"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses