APG PayAPG Paydocs

Merchants

List travel file errors

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

Return the records of this file that failed their checks, each with the codes it raised. The line a record failed on is never published.

Permissions

Required permission
merchantTravelData:query

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

Path parameters

travelFileIdstring
required

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

Responses

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

Discriminated by type
type = "TvlfileErrorPageAttributes"
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": "TvlfileErrorPageAttributes",
  "data": [
    {
      "type": "TvlfileErrorAttributes",
      "travelFileErrorId": "tvlerr_9f2Kd8QpLzXw",
      "errorType": "File",
      "travelBatchId": "tvlbat_9f2Kd8QpLzXw",
      "travelEntryId": "tvlent_9f2Kd8QpLzXw",
      "lineNumber": 1250,
      "codes": [
        {
          "type": "TvlfileErrorCodeAttributes",
          "code": "string",
          "message": "string"
        }
      ],
      "corrected": true,
      "timedOut": true,
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses