APG PayAPG Paydocs

Merchants

List travel uploads

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

Return a page of a merchant's uploads, newest first unless sort says otherwise. Name the merchant with merchantId or the Merchant-Id header. Query with fileName to find out whether a file has already been uploaded.

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 TvluplSort

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

columnsarray of TvluplColumn

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

fileNamestring

Uploads whose file name contains this text.

statusTvluplStatus

Narrow to uploads in this state.

UploadingUploadedFailedUnknown
createdFromstring (date-time)

Uploads recorded at or after this instant.

createdTostring (date-time)

Uploads recorded at or before this instant.

Responses

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

Discriminated by type
type = "TvluplPageAttributes"
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": "TvluplPageAttributes",
  "data": [
    {
      "type": "TvluplViewAttributes",
      "travelUploadId": "tvlupl_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "fileName": "Ada Lovelace",
      "uploaderReference": "your-own-reference",
      "uploaderName": "Ada Lovelace",
      "status": "Uploading",
      "failureMessage": "string",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses