APG PayAPG Paydocs

Merchants

Get travel file batch

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

Return one batch of this file. A batch that does not belong to this travelFile is a 404, not a redirect.

Permissions

Required permission
merchantTravelData:query

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

Path parameters

travelFileIdstring
required
batchIdstring
required

Responses

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

Discriminated by type
type = "TvlfileBatchAttributes"
travelBatchIdTvlfileBatchIdrequired

Identifier of a batch of a travel file.

Example tvlbat_9f2Kd8QpLzXw

ownerMerchantIdMchtIdrequired

The merchant the batch's entries belong to.

Example mcht_9f2Kd8QpLzXw

partnerCodestringrequired

The twelve-digit merchant code the batch's header states.

fileTypeTvlfileTyperequired
MerchantBspEnrichmentUnknown
processingDatestring (date)required

Example 2026-08-19

versionstringrequired

The file layout version, such as V02.01.

releasestringrequired
countryCodestringrequired

Example AU

acquirerPrefixstringrequired
processingPagestringrequired

The acquirer processing page the header states.

creditCardIndicatorstringrequired
bosReferencestringrequired

Example your-own-reference

fileReferencestringrequired

Example your-own-reference

recordCountinteger (int32)required

Example 42

startLineinteger (int32)required

The line of the file the batch starts on.

Example 1250

endLineinteger (int32)required

Example 1250

currencyIsoCurrency
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
validationTvlfileValidationrequired
PassedFailedUnknown
Example
{
  "type": "TvlfileBatchAttributes",
  "travelBatchId": "tvlbat_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"
}

Error responses