APG PayAPG Paydocs

Merchants

Get travel file

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

Return one travel file.

Permissions

Required permission
merchantTravelData:query

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

Path parameters

travelFileIdstring
required

Responses

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

Discriminated by type
type = "TvlfileViewAttributes"
travelFileIdTvlfileIdrequired

Identifier of a travel file.

Example tvlfile_9f2Kd8QpLzXw

merchantIdMchtIdrequired

Identifier of a merchant.

Example mcht_9f2Kd8QpLzXw

merchantCodestring

The merchant's twelve-digit code, as the file's headers state it.

namestringrequired

Example Ada Lovelace

tokenisedNamestring

The name of the copy of the file kept once its card numbers were tokenised.

Example Ada Lovelace

fileTypeTvlfileTyperequired
MerchantBspEnrichmentUnknown
currencyIsoCurrency

The currency of the file's transactions, once it is known.

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

parseStatusTvlfileParseStatusrequired
NotRequiredWaitingProcessingParsedFailedUnknown
dealStatusTvlfileDealStatusrequired
WaitingProcessingProcessedUnknown
reportStatusTvlfileReportStatusrequired

Whether the file's quality-check report has gone to the partner.

WaitingSentFailedUnknown
validationTvlfileValidationrequired

Whether the file passed its checks.

PassedFailedUnknown
createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses