List travel entry refund candidates
/travel-entries/{travelEntryId}/refund-candidatescurl -X GET https://api.tst.au.apgpay.dev/travel-entries/{travelEntryId}/refund-candidates \
-H "Authorization: Bearer $API_KEY"Return the purchases this refund may be a refund of, oldest first, for the staff who relink it with TvlentUpdateRelinkOriginal. They are found on the refund's own card, which is never published, and are the owner's matched purchases of the refund's kind of file and processing page with at least the refund's amount still unrefunded. matchOn adds the references they must share with it. Only a refund has candidates.
Permissions
merchantTravelData:updateRequires the `update` action on `merchantTravelData` for the supplied runtime context
Path parameters
travelEntryIdstringQuery parameters
pageinteger (int32)1-based page number.
limitinteger (int32)Maximum items per page.
matchOnone of TvlentRefundMatchField, array of TvlentRefundMatchFieldWhat else a purchase must share with the refund. Repeat the parameter to require several. A purchase is always on the refund's card, owner, kind of file and processing page, with at least the refund's amount unrefunded.
Responses
The response is a tagged shape: type is always "TvlentRefundCandidatePageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "TvlentRefundCandidatePageAttributes"typeenumrequiredTvlentViewAttributestravelEntryIdTvlentIdrequiredIdentifier of a travel entry.
Example tvlent_9f2Kd8QpLzXw
travelFileIdTvlfileIdrequiredThe file it came in. Read it at /travel-files/{travelFileId}.
Example tvlfile_9f2Kd8QpLzXw
travelBatchIdTvlfileBatchIdrequiredThe batch it came in.
Example tvlbat_9f2Kd8QpLzXw
merchantIdMchtIdrequiredThe merchant the file was uploaded for.
Example mcht_9f2Kd8QpLzXw
ownerMerchantIdMchtIdrequiredThe merchant the entry belongs to, which is who the portal reads it as.
Example mcht_9f2Kd8QpLzXw
fileTypeTvlfileTyperequiredMerchantBspEnrichmentUnknownprocessingDatestring (date)requiredExample 2026-08-19
lineNumberinteger (int32)requiredThe line of the file the entry was read from.
Example 1250
serviceKindTvlentServiceKindFlightHotelCarTrainShipFeeOtherCommissionTasfUnknownsignTvlentSignPurchaseRefundUnknowncardTypeTvlentCardTyperequiredUatpMastercardUnknownhasCardTokenbooleanrequiredWhether the line carried a tokenised card. The token itself is never published.
Example true
documentNumberFormatstringrequiredExample 2026-08-19T04:21:07Z
documentNumberstringrequiredserialNumberstringrequiredpurchaseDatestring (date)Example 2026-08-19
travellerNamestringThe 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.
typeenumrequiredTvlentAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
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
amountMinorUnitsrequiredThe entry's total.
Example 1250
netAmountNonVatableMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
netAmountVatableMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
vatAmountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
refundedAmountMinorUnitsrequiredHow much of the entry has been refunded so far. PATCH it with TvlentUpdateResetRefundedAmount.
Example 1250
vatPercentagestringrequiredThe VAT rate as a decimal string, 19.00.
vatIndicatorstringrequiredapprovalCodestringrequiredThe merchant's own details and references, as the line stated them.
typeenumrequiredTvlentMerchantDetailsAttributesnamestringrequiredExample Ada Lovelace
citystringrequiredzipCodestringstateCodestringiataNumberstringrequiredinvoiceNumberstringrequiredorderNumberstringrequiredcustomerNumberstringrequiredagencyDossierNumberstringrequiredagencyDeliveryNoteNumberstringrequiredusageCodestringrequiredvalidationTvlfileValidationrequiredPassedFailedUnknownThe ten references a line carries for the data-based invoicing check. An empty string is a field the line left blank.
typeenumrequiredTvlentDbiAttributespkstringrequireddsstringrequiredksstringrequiredaestringrequiredikstringrequiredbdstring (date)Example 2026-08-19
prstringrequiredaustringrequiredakstringrequiredrzstringrequiredstatusTvlentDbiStatusrequiredNotRequiredWaitingPassedFailedUnknownstatusAtstring (date-time)Example 2026-08-19T04:21:07Z
statusMessagestringWhat the check said, where it failed.
Example Active
mandatoryFieldsstringThe references the check required.
Where matching an entry to its payment has got to, and what it was matched to.
typeenumrequiredTvlentMatchAttributesstatusTvlentMatchStatusrequiredNotRequiredWaitingProcessingMatchedFailedUnknownstatusAtstring (date-time)Example 2026-08-19T04:21:07Z
statusMessagestringExample Active
timedOutbooleanrequiredWhether the matching gave up waiting for the payment.
Example true
needsManualOriginalMatchbooleanrequiredWhether a refund is waiting for staff to say which purchase it refunds.
Example true
originalTravelEntryIdTvlentIdThe purchase this refund refunds. Read it at /travel-entries/{travelEntryId}.
Example tvlent_9f2Kd8QpLzXw
transactionIdTranIdThe payment the entry was matched to. Read it at /transactions/{transactionId}.
Example tran_9f2Kd8QpLzXw
refundIdRfndIdThe refund the entry was matched to. Read it at /refunds/{refundId}.
Example rfnd_9f2Kd8QpLzXw
issuerTransactionIdItxnIdThe card transaction the entry was matched to. Read it at /issuer-transactions/{issuerTransactionId}.
Example itxn_9f2Kd8QpLzXw
issuerRefundIdItxnIdThe card refund the entry was matched to.
Example rfnd_9f2Kd8QpLzXw
loanIdLoanIdThe loan the matched payment was drawn on.
Example loan_9f2Kd8QpLzXw
customerIdCustIdThe customer the matched payment was for.
Example cust_9f2Kd8QpLzXw
enabledbooleanrequiredWhether 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.
typeA car rental. Its charges are in currency.
currencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
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
rentalCompanyCodestringrequiredcontractNumberstringrequiredvehicleClassCodestringrequiredvehicleTypestringrequirednoShowbooleanrequiredExample true
pickUpDatestring (date)Example 2026-08-19
pickUpTimestringpickUpLocationCodestringrequiredpickUpLocationCitystringrequiredreturnDatestring (date)Example 2026-08-19
returnTimestringreturnLocationCodestringrequiredreturnLocationCitystringrequiredrentalDaysinteger (int32)requiredExample 1250
mileageIndicatorstringrequireddrivenDistancestringThe distance driven, as a decimal string.
typeenumrequiredTvlentCarChargeAttributeskindstringrequiredamountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
vatIndicatorstringrequiredA fee. Its matching criteria are not published: for a booking-engine fee they are the card number the booking was made with.
originatorstringrequiredserviceQualifierstringrequireddocumentNumberFormatstringrequiredExample 2026-08-19T04:21:07Z
crsstringrequiredtitlestringrequiredA flight. Its taxes are in currency.
currencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
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
departureDatestring (date)Example 2026-08-19
originLocationstringrequiredcrsstringrequiredpassengerCountinteger (int32)requiredExample 42
conjunctionTicketsarray of stringsegmentOverflowbooleanrequiredExample true
ticketIndicatorstringrequiredtourCodestringrequiredtypeenumrequiredTvlentFlightTaxAttributestaxTypestringrequiredamountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
typeenumrequiredTvlentFlightSegmentAttributesdestinationstringrequiredairlinestringrequiredflightstringrequiredflightClassstringrequiredA hotel stay. Its room amount and services are in currency.
currencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
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
companyCodestringrequiredcontractNumberstringrequirednamestringrequiredExample Ada Lovelace
stayReasonIndicatorstringrequiredExample Requested by the customer.
noShowbooleanrequiredExample true
checkInDatestring (date)Example 2026-08-19
checkInTimestringcheckOutDatestring (date)Example 2026-08-19
checkOutTimestringlocationCodestringrequiredlocationCitystringrequiredguestCountinteger (int32)requiredExample 42
nightsinteger (int32)requiredExample 1250
netRoomAmountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
netRoomVatIndicatorstringrequiredprepaidExpensesinteger (int32)requiredExample 1250
descriptionstringrequiredtypeenumrequiredTvlentHotelChargeAttributescodestringrequiredamountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
vatIndicatorstringrequiredAny other service. Its matching criteria are not published.
descriptionsarray of stringA sea journey.
companyNamestringrequiredExample Ada Lovelace
departureDatestring (date)Example 2026-08-19
originCodestringrequiredoriginCitystringrequiredpassengerCountinteger (int32)requiredExample 42
arrivalDatestring (date)Example 2026-08-19
arrivalCodestringrequiredarrivalCitystringrequireddescriptionsarray of stringA rail journey.
companyNamestringrequiredExample Ada Lovelace
departureDatestring (date)Example 2026-08-19
originCodestringrequiredoriginCitystringrequiredpassengerCountinteger (int32)requiredExample 42
ticketTypestringrequiredsegmentOverflowbooleanrequiredExample true
finalDestinationCodestringrequiredfinalDestinationCitystringrequireddescriptionstringrequiredtypeenumrequiredTvlentTrainSegmentAttributesdestinationCodestringrequireddestinationCitystringrequiredtrainNumberstringrequiredtrainClassstringrequiredcreatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
hasMorebooleanrequiredWhether further items exist after this page.
Example true
nextStartingAfterstringId 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
{
"type": "TvlentRefundCandidatePageAttributes",
"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)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn 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.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}