APG PayAPG Paydocs

Merchants

List travel batches

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

Return a page of the batches across a merchant's travel files, the newest file first unless sort says otherwise. Name whose batches with merchantId, ownerMerchantId or travelFileId, or the Merchant-Id header.

Permissions

Required permission
merchantTravelData:query

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

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

sortarray of TvlbatSort

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

columnsarray of TvlbatColumn

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

merchantIdstring

The merchant that uploaded the files. Omit it when the Merchant-Id header names the merchant, or when ownerMerchantId or travelFileId says whose batches to read.

ownerMerchantIdstring

Only the batches whose entries belong to this merchant, in files any merchant uploaded.

travelFileIdstring

Only the batches of this file.

createdFromstring (date-time)

Batches whose file was received at or after this instant.

createdTostring (date-time)

Batches whose file was received at or before this instant.

Responses

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

Discriminated by type
type = "TvlbatPageAttributes"
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": "TvlbatPageAttributes",
  "data": [
    {
      "type": "TvlbatViewAttributes",
      "travelBatchId": "tvlbat_9f2Kd8QpLzXw",
      "travelFileId": "tvlfile_9f2Kd8QpLzXw",
      "fileName": "Ada Lovelace",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "ownerMerchantId": "mcht_9f2Kd8QpLzXw",
      "partnerCode": "string",
      "fileType": "Merchant",
      "processingDate": "2026-08-19",
      "version": "string",
      "release": "string",
      "countryCode": "AU",
      "acquirerPrefix": "string",
      "processingPage": "string",
      "creditCardIndicator": "string",
      "bosReference": "your-own-reference",
      "fileReference": "your-own-reference",
      "recordCount": 42,
      "startLine": 1250,
      "endLine": 1250,
      "currency": "AUD",
      "parseStatus": "NotRequired",
      "dealStatus": "Waiting",
      "validation": "Passed",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses