List travel entries

GET/travel-entries

Request

GEThttps://api.tst.au.apgpay.dev/travel-entries

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

Return a page of travel entries, newest first unless sort says otherwise. Name the owner with merchantId or the Merchant-Id header, or the merchant their files were uploaded for with uploadedForMerchantId; naming neither is a 400. To check that entries belong to a merchant before changing them, query them and read ownerMerchantId. Entries a later file replaced are left out unless includeSuperseded is true. Text filters match any entry that contains the text, and case matters.

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 TvlentSort

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

columnsarray of TvlentColumn

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 entries to read. Omit it when the Merchant-Id header names the merchant, or when uploadedForMerchantId is given instead.

travelFileIdstring

Entries from this file.

fileTypeTvlfileType

Narrow to one kind of file.

MerchantBspEnrichmentUnknown

documentNumberstring

Entries whose document number contains this text.

matchStatusTvlentMatchStatus

Narrow to entries at this stage of matching.

NotRequiredWaitingProcessingMatchedFailedUnknown

dbiStatusTvlentDbiStatus

Narrow to entries at this stage of the data-based invoicing check.

NotRequiredWaitingPassedFailedUnknown

validationTvlfileValidation

Narrow to entries that passed or failed their checks.

PassedFailedUnknown

createdFromstring (date-time)

Entries received at or after this instant.

createdTostring (date-time)

Entries received at or before this instant.

uploadedForMerchantIdstring

Entries from files uploaded for this merchant, which for a distributor's file is not the merchant the entries belong to. Given without merchantId, it lists them whoever owns them, for staff; any other caller sees only the entries it also owns.

includeSupersededboolean

List the entries a later file replaced as well as the live ones.

authorisationStatusTvlentAuthStatus

Narrow to entries whose authorisation is at this stage.

NotRequiredWaitingProcessingSucceededFailedUnknown

authorisationRefundStatusTvlentAuthStatus

Narrow to entries whose authorisation refund is at this stage.

NotRequiredWaitingProcessingSucceededFailedUnknown

matchTimedOutboolean

Narrow to entries whose matching has, or has not, given up waiting for the payment.

travelBatchIdstring

Entries from this batch of a file.

agencyDeliveryNoteNumberstring

Entries whose agency delivery note number contains this text. Case matters.

travellerNamestring

Entries whose traveller's name contains this text. Case matters.

transactionIdstring

Entries matched to this payment.

issuerTransactionIdstring

Entries matched to this card transaction.

refundIdstring

Entries matched to this refund.

issuerRefundIdstring

Entries matched to this card refund.

Responses

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

Discriminated by type

type = "TvlentPageAttributes"

typeenumrequired

TvlentViewAttributes

travelEntryIdTvlentIdrequired

Identifier of a travel entry.

Example tvlent_9f2Kd8QpLzXw

travelFileIdTvlfileIdrequired

The file it came in. Read it at /travel-files/{travelFileId}.

Example tvlfile_9f2Kd8QpLzXw

travelBatchIdTvlfileBatchIdrequired

The batch it came in.

Example tvlbat_9f2Kd8QpLzXw

merchantIdMchtIdrequired

The merchant the file was uploaded for.

Example mcht_9f2Kd8QpLzXw

ownerMerchantIdMchtIdrequired

The merchant the entry belongs to, which is who the portal reads it as.

Example mcht_9f2Kd8QpLzXw

fileTypeTvlfileTyperequired

MerchantBspEnrichmentUnknown

processingDatestring (date)required

Example 2026-08-19

lineNumberinteger (int32)required

The line of the file the entry was read from.

Example 1250

serviceKindTvlentServiceKind

FlightHotelCarTrainShipFeeOtherCommissionTasfUnknown

signTvlentSign

PurchaseRefundUnknown

cardTypeTvlentCardTyperequired

UatpMastercardUnknown

hasCardTokenbooleanrequired

Whether the line carried a tokenised card. The token itself is never published.

Example true

documentNumberFormatstringrequired

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

documentNumberstringrequired

serialNumberstringrequired

purchaseDatestring (date)

Example 2026-08-19

travellerNamestring

The traveller's name, as the line stated it.

Example Ada Lovelace

The amounts on a travel entry. All are in the single currency given here.

approvalCodestringrequired

The merchant's own details and references, as the line stated them.

usageCodestringrequired

validationTvlfileValidationrequired

PassedFailedUnknown

The ten references a line carries for the data-based invoicing check. An empty string is a field the line left blank.

Where an entry's authorisation and its refund have got to.

Where matching an entry to its payment has got to, and what it was matched to.

enabledbooleanrequired

Whether the entry is still live. A disabled entry has been superseded.

Example true

What the entry paid for. Empty for a commission or TASF line.

One of, by type

A car rental. Its charges are in currency.

currencyIsoCurrencyrequired

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

rentalCompanyCodestringrequired

contractNumberstringrequired

vehicleClassCodestringrequired

vehicleTypestringrequired

noShowbooleanrequired

Example true

pickUpDatestring (date)

Example 2026-08-19

pickUpTimestring

pickUpLocationCodestringrequired

pickUpLocationCitystringrequired

returnDatestring (date)

Example 2026-08-19

returnTimestring

returnLocationCodestringrequired

returnLocationCitystringrequired

rentalDaysinteger (int32)required

Example 1250

mileageIndicatorstringrequired

drivenDistancestring

The distance driven, as a decimal string.

A fee. Its matching criteria are not published: for a booking-engine fee they are the card number the booking was made with.

originatorstringrequired

serviceQualifierstringrequired

documentNumberFormatstringrequired

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

relatedDocumentNumberstringrequired

crsstringrequired

titlestringrequired

A flight. Its taxes are in currency.

currencyIsoCurrencyrequired

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB

+156 more

departureDatestring (date)

Example 2026-08-19

originLocationstringrequired

crsstringrequired

passengerCountinteger (int32)required

Example 42

conjunctionTicketsarray of string

segmentOverflowbooleanrequired

Example true

ticketIndicatorstringrequired

tourCodestringrequired

A hotel stay. Its room amount and services are in currency.

currencyIsoCurrencyrequired

AFNDZDARSAMDAWGAUDAZNBSDBHDTHB

+156 more

companyCodestringrequired

contractNumberstringrequired

namestringrequired

Example Ada Lovelace

stayReasonIndicatorstringrequired

Example Requested by the customer.

noShowbooleanrequired

Example true

checkInDatestring (date)

Example 2026-08-19

checkInTimestring

checkOutDatestring (date)

Example 2026-08-19

checkOutTimestring

locationCodestringrequired

locationCitystringrequired

guestCountinteger (int32)required

Example 42

nightsinteger (int32)required

Example 1250

netRoomAmountMinorUnitsrequired

An amount in the minor units of the currency given by the enclosing object's currency field.

Example 1250

netRoomVatIndicatorstringrequired

prepaidExpensesinteger (int32)required

Example 1250

descriptionstringrequired

Any other service. Its matching criteria are not published.

descriptionsarray of string

A sea journey.

companyNamestringrequired

Example Ada Lovelace

departureDatestring (date)

Example 2026-08-19

originCodestringrequired

originCitystringrequired

passengerCountinteger (int32)required

Example 42

arrivalDatestring (date)

Example 2026-08-19

arrivalCodestringrequired

arrivalCitystringrequired

descriptionsarray of string

A rail journey.

companyNamestringrequired

Example Ada Lovelace

departureDatestring (date)

Example 2026-08-19

originCodestringrequired

originCitystringrequired

passengerCountinteger (int32)required

Example 42

ticketTypestringrequired

segmentOverflowbooleanrequired

Example true

finalDestinationCodestringrequired

finalDestinationCitystringrequired

descriptionstringrequired

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

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": "TvlentPageAttributes",
  "data": [
    {
      "type": "TvlentViewAttributes",
      "travelEntryId": "tvlent_9f2Kd8QpLzXw",
      "travelFileId": "tvlfile_9f2Kd8QpLzXw",
      "travelBatchId": "tvlbat_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "ownerMerchantId": "mcht_9f2Kd8QpLzXw",
      "fileType": "Merchant",
      "processingDate": "2026-08-19",
      "lineNumber": 1250,
      "serviceKind": "Flight",
      "sign": "Purchase",
      "cardType": "Uatp",
      "hasCardToken": true,
      "documentNumberFormat": "2026-08-19T04:21:07Z",
      "documentNumber": "string",
      "serialNumber": "string",
      "purchaseDate": "2026-08-19",
      "travellerName": "Ada Lovelace",
      "amounts": {
        "type": "TvlentAmountsAttributes",
        "currency": "AUD",
        "amount": 1250,
        "netAmountNonVatable": 1250,
        "netAmountVatable": 1250,
        "vatAmount": 1250,
        "refundedAmount": 1250,
        "vatPercentage": "string",
        "vatIndicator": "string"
      },
      "approvalCode": "string",
      "merchantDetails": {
        "type": "TvlentMerchantDetailsAttributes",
        "name": "Ada Lovelace",
        "city": "string",
        "zipCode": "string",
        "stateCode": "string",
        "iataNumber": "string",
        "invoiceNumber": "string",
        "orderNumber": "string",
        "customerNumber": "string",
        "agencyDossierNumber": "string",
        "agencyDeliveryNoteNumber": "string"
      },
      "usageCode": "string",
      "validation": "Passed",
      "dbi": {
        "type": "TvlentDbiAttributes",
        "pk": "string",
        "ds": "string",
        "ks": "string",
        "ae": "string",
        "ik": "string",
        "bd": "2026-08-19",
        "pr": "string",
        "au": "string",
        "ak": "string",
        "rz": "string",
        "status": "NotRequired",
        "statusAt": "2026-08-19T04:21:07Z",
        "statusMessage": "Active",
        "mandatoryFields": "string"
      },
      "authorisation": {
        "type": "TvlentAuthorisationAttributes",
        "operator": "ApgPay",
        "status": "NotRequired",
        "statusAt": "2026-08-19T04:21:07Z",
        "statusMessage": "Active",
        "refundStatus": "NotRequired",
        "refundStatusAt": "2026-08-19T04:21:07Z"
      },
      "matching": {
        "type": "TvlentMatchAttributes",
        "status": "NotRequired",
        "statusAt": "2026-08-19T04:21:07Z",
        "statusMessage": "Active",
        "timedOut": true,
        "needsManualOriginalMatch": true,
        "originalTravelEntryId": "tvlent_9f2Kd8QpLzXw",
        "transactionId": "tran_9f2Kd8QpLzXw",
        "refundId": "rfnd_9f2Kd8QpLzXw",
        "issuerTransactionId": "itxn_9f2Kd8QpLzXw",
        "issuerRefundId": "rfnd_9f2Kd8QpLzXw",
        "loanId": "loan_9f2Kd8QpLzXw",
        "customerId": "cust_9f2Kd8QpLzXw"
      },
      "enabled": true,
      "serviceLines": [
        {
          "type": "TvlentServiceLineCar",
          "currency": "AUD",
          "rentalCompanyCode": "string",
          "contractNumber": "string",
          "vehicleClassCode": "string",
          "vehicleType": "string",
          "noShow": true,
          "pickUpDate": "2026-08-19",
          "pickUpTime": "string",
          "pickUpLocationCode": "string",
          "pickUpLocationCity": "string",
          "returnDate": "2026-08-19",
          "returnTime": "string",
          "returnLocationCode": "string",
          "returnLocationCity": "string",
          "rentalDays": 1250,
          "mileageIndicator": "string",
          "drivenDistance": "string",
          "charges": [
            {
              "type": "TvlentCarChargeAttributes",
              "kind": "string",
              "amount": 1250,
              "vatIndicator": "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

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}