APG PayAPG Paydocs

Merchants

List travel files

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

Return a page of a merchant's travel files, newest first unless sort says otherwise. Name the merchant with merchantId 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 TvlfileSort

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

columnsarray of TvlfileColumn

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 files to read. Omit it when the Merchant-Id header names the merchant.

namestring

Files whose name contains this text.

fileTypeTvlfileType

Narrow to one kind of file.

MerchantBspEnrichmentUnknown
parseStatusTvlfileParseStatus

Narrow to files at this stage of parsing.

NotRequiredWaitingProcessingParsedFailedUnknown
dealStatusTvlfileDealStatus

Narrow to files at this stage of processing.

WaitingProcessingProcessedUnknown
validationTvlfileValidation

Narrow to files that passed or failed their checks.

PassedFailedUnknown
createdFromstring (date-time)

Files received at or after this instant.

createdTostring (date-time)

Files received at or before this instant.

Responses

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

Discriminated by type
type = "TvlfilePageAttributes"
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": "TvlfilePageAttributes",
  "data": [
    {
      "type": "TvlfileViewAttributes",
      "travelFileId": "tvlfile_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "merchantCode": "string",
      "name": "Ada Lovelace",
      "tokenisedName": "Ada Lovelace",
      "fileType": "Merchant",
      "currency": "AUD",
      "parseStatus": "NotRequired",
      "dealStatus": "Waiting",
      "reportStatus": "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