APG PayAPG Paydocs

Settlement

List settlement entries

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

Return a page of a merchant's settlement entries. A merchant is required, named by merchantId, a payoutId or the Merchant-Id header, and so is a period: clearingFrom and clearingTo, or createdAfter and createdBefore, or a payoutId in place of either. The filters combine with each other and with q by AND. GET /filter-catalogues/settlement-entries 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.

Permissions

Required permission
merchantFinancials:query

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

Query parameters

qstring

Search. Matches an entry id, the whole reference or transaction id exactly, or the description. 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. Matches come newest 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 SettlementEntrySort

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

columnsarray of SettlementEntryColumn

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

merchantIdstring

Whose settlement to read. Omit it when a payoutId or the Merchant-Id header names the merchant.

payoutIdstring

Explain one payout: the entries it settled. Supplying this makes the date range optional.

entryTypeone of array of string, string

Only entries whose entry type is one of these. Repeat the parameter to give several.

transactionIdone of array of string, string

Only entries whose transaction is one of these. Repeat the parameter to give several.

categoryone of JnalCategory, array of JnalCategory

Only entries whose journal is one of these. Repeat the parameter to give several.

currencyIsoCurrency

Defaults to the merchant's trading currency when omitted.

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB
+156 more

PAB, BBD, BYR, BZD, BMD, VEF, BOB, BRL, BND, BGN, BIF, CAD, CVE, KYD, XOF, XAF, XPF, CLP, COP, KMF, CDF, BAM, NIO, CRC, HRK, CUP, CZK, GMD, DKK, MKD, DJF, STD, DOP, VND, XCD, EGP, SVC, ETB, EUR, FKP, FJD, HUF, GHS, GIP, HTG, PYG, GNF, GYD, HKD, UAH, ISK, INR, IRR, IQD, JMD, JOD, KES, PGK, LAK, KWD, MWK, AOA, MMK, GEL, LBP, ALL, HNL, SLL, LRD, LYD, SZL, LSL, MGA, MYR, MUR, MXN, MXV, MDL, MAD, MZN, BOV, NGN, ERN, NAD, NPR, ANG, ILS, TWD, NZD, BTN, KPW, NOK, PEN, MRU, PKR, MOP, TOP, CUC, UYU, PHP, GBP, BWP, QAR, GTQ, ZAR, OMR, KHR, RON, MVR, IDR, RUB, RWF, SHP, SAR, RSD, SCR, SGD, SBD, KGS, SOS, TJS, SSP, LKR, SDG, SRD, SEK, CHF, SYP, BDT, WST, TZS, KZT, TTD, MNT, TND, TRY, TMT, AED, UGX, COU, CLF, UYI, USD, USN, USS, UZS, VUV, CHE, CHW, KRW, YER, JPY, CNY, ZMW, ZWL, PLN

amountFromnumber

Only entries whose amount is at least this.

amountTonumber

Only entries whose amount is at most this.

clearingFromstring (date)

Only entries whose clearing day is at or after this ISO-8601 date.

clearingTostring (date)

Only entries whose clearing day is at or before this ISO-8601 date.

createdAfterstring (date-time)

Only entries whose journalling time is at or after this ISO-8601 timestamp.

createdBeforestring (date-time)

Only entries whose journalling time is before, and not at, this ISO-8601 timestamp.

Responses

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

Discriminated by type
type = "SettlementEntryPageAttributes"
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": "SettlementEntryPageAttributes",
  "data": [
    {
      "type": "SettlementEntryViewAttributes",
      "entry": {
        "type": "JnalViewAttributes",
        "journalEntryId": "sjen_9f2Kd8QpLzXw",
        "counterEntryId": "sjen_9f2Kd8QpLzXw",
        "journal": {
          "type": "SjnlBusinessKeyAttributes",
          "ownerType": "Merchant",
          "ownerIdentifier": "string",
          "category": "General",
          "clearanceSystem": "string",
          "currency": "AUD"
        },
        "entryType": "string",
        "amounts": {
          "type": "JnalAmountsAttributes",
          "currency": "AUD",
          "debit": "string",
          "credit": "string",
          "tax": "string",
          "taxRate": "0.9412",
          "taxType": "string",
          "taxCountry": "AU"
        },
        "event": {
          "type": "JnalEventAttributes",
          "systemEventId": "string",
          "systemEventType": "string"
        },
        "merchantId": "mcht_9f2Kd8QpLzXw",
        "marketplaceId": "mktp_9f2Kd8QpLzXw",
        "enterpriseId": "ent_9f2Kd8QpLzXw",
        "originalAmount": {
          "type": "IsoCurrencyAmount",
          "minorCurrencyUnits": 1250,
          "currency": "AUD"
        },
        "description": "string",
        "clearanceDate": "2026-08-19",
        "settlementDate": "2026-08-19",
        "referenceId": "your-own-reference",
        "metadata": {
          "yourKey": "string"
        },
        "createdAt": "2026-08-19T04:21:07Z"
      },
      "payoutId": "payout_9f2Kd8QpLzXw"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses