Get transaction
/transactions/{transactionId}curl -X GET https://api.tst.au.apgpay.dev/transactions/{transactionId} \
-H "Authorization: Bearer $API_KEY"Return one transaction.
Permissions
transactions:queryRequires the `query` action on `transactions` for the supplied runtime context
Path parameters
transactionIdstringResponses
The response is a tagged shape: type is always "TranViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "TranViewAttributes"transactionIdTranIdrequiredIdentifier of a transaction.
Example tran_9f2Kd8QpLzXw
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
Who paid, carried here so a report does not need a second call.
typeenumrequiredRfndCustomerAttributescustomerIdCustIdIdentifier of a customer.
Example cust_9f2Kd8QpLzXw
namestringThe customer's display name.
Example Ada Lovelace
emailAddressstringAbsent unless the principal may read customer PII.
Example ada@example.com
phoneNumberstringAbsent unless the principal may read customer PII.
Example +61400000000
orderIdOrdrIdrequiredThe order this payment settles. Every transaction has one, the platform creates one where the caller did not.
Example ordr_9f2Kd8QpLzXw
referenceOrderIdstringYour own reference for that order.
Example your-own-reference
paymentTypeTranPaymentTyperequiredHow the payment was structured, in full, or over instalments.
PayInFullPayPlanUnknownstatusTranStatusrequiredAcceptedCapturedAuthorisedPendingAwaitingAuthenticationPartiallyRefundedRefundedDisputedFailedCancelled+1 moreShow fewer
Unknown
The amounts on a transaction. All are in the single currency given here.
typeenumrequiredTranAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
amountMinorUnitsrequiredWhat the payer was charged, surcharge included.
Example 1250
surchargeMinorUnitsrequiredThe surcharge the payer bore for the method used, included in amount.
Example 1250
refundedMinorUnitsrequiredHow much of amount has been refunded.
Example 1250
feeMinorUnitsPlatform fee deducted from the merchant. Absent unless the principal may read merchant financials.
Example 1250
The refunds issued against this transaction, in full.
typeenumrequiredRfndViewAttributesrefundIdRfndIdrequiredIdentifier of a refund.
Example rfnd_9f2Kd8QpLzXw
The transaction this refund came from, acquiring or issuing.
typeenumrequiredRfndSubjectTransactiontransactionIdTranIdrequiredIdentifier of a transaction.
Example tran_9f2Kd8QpLzXw
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
Who was paid back.
typeenumrequiredRfndCustomerAttributescustomerIdCustIdIdentifier of a customer.
Example cust_9f2Kd8QpLzXw
namestringThe customer's display name.
Example Ada Lovelace
emailAddressstringAbsent unless the principal may read customer PII.
Example ada@example.com
phoneNumberstringAbsent unless the principal may read customer PII.
Example +61400000000
statusRfndStatusrequiredPendingRefundedSettledReversedUnknownA refund and the transaction it came from. Both are in the single currency given here.
typeenumrequiredRfndAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
amountMinorUnitsrequiredHow much came back.
Example 1250
transactionAmountMinorUnitsWhat the original transaction was for, beside what came back.
Example 1250
orderIdOrdrIdThe order the refunded payment settled.
Example ordr_9f2Kd8QpLzXw
referenceOrderIdstringYour own reference for that order.
Example your-own-reference
orderMetadatamap of any JSON valueFree-form data carried on the order. Absent unless the principal may read order PII.
payoutIdPayoutIdThe payout this refund was deducted from. Absent unless the principal may read merchant financials.
Example payout_9f2Kd8QpLzXw
settlementDatestring (date)The date the payout carrying this refund settles.
Example 2026-08-19
attemptsinteger (int32)requiredHow many times the platform has attempted this refund with the gateway.
Example 1250
lastErrorstringWhat the gateway said when the refund last failed.
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
refundedAtstring (date-time)Example 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
The disputes raised against this transaction, in full.
typeenumrequiredDisputeViewAttributesdisputeIdDisputeIdrequiredIdentifier of a dispute.
Example dispute_9f2Kd8QpLzXw
The transaction this dispute challenges, acquiring or issuing.
typeenumrequiredRfndSubjectTransactiontransactionIdTranIdrequiredIdentifier of a transaction.
Example tran_9f2Kd8QpLzXw
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
Who was paid back.
typeenumrequiredRfndCustomerAttributescustomerIdCustIdIdentifier of a customer.
Example cust_9f2Kd8QpLzXw
namestringThe customer's display name.
Example Ada Lovelace
emailAddressstringAbsent unless the principal may read customer PII.
Example ada@example.com
phoneNumberstringAbsent unless the principal may read customer PII.
Example +61400000000
statusDisputeStatusrequiredThe scheme's decision, as the platform records it.
PendingWonLostUnknowngatewayStatestringThe gateway's own word for where the case is. Free-form, because the gateways do not agree on a vocabulary.
What a dispute challenges. Both amounts are in the single currency given here.
typeenumrequiredDisputeAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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 amount being challenged.
Example 1250
transactionAmountMinorUnitsWhat the original transaction was for.
Example 1250
What the platform charges the merchant for handling the dispute. Billed in the platform's own currency, which is why it carries one rather than joining the money set.
typeenumrequiredIsoCurrencyAmountminorCurrencyUnitsinteger (int64)requiredThe amount in minor currency units (e.g. cents for AUD).
Example 1250
currencyIsoCurrencyrequiredThe currency of the given amount as a 3 letter ISO code.
AFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
reasonstringExample Requested by the customer.
descriptionstringorderIdOrdrIdrequiredThe order the disputed payment settled.
Example ordr_9f2Kd8QpLzXw
referenceOrderIdstringExample your-own-reference
orderMetadatamap of any JSON valueFree-form data the platform stores and returns untouched. Values may be nested objects and arrays.
evidenceDueBystring (date)When evidence must be submitted by.
Example 2026-08-19
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
payoutIdPayoutIdThe payout this payment settled in. Absent unless the principal may read merchant financials.
Example payout_9f2Kd8QpLzXw
settlementDatestring (date)The date that payout settles.
Example 2026-08-19
availableOnstring (date)The date the funds became available to pay out.
Example 2026-08-19
referenceTransactionIdstringThe caller's own reference for this transaction.
Example your-own-reference
referenceIssuerTransactionIdstringThe issuer transaction this payment was made with, where the payer used a card the platform issued.
Example your-own-reference
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
{
"type": "TranViewAttributes",
"transactionId": "tran_9f2Kd8QpLzXw",
"merchantId": "mcht_9f2Kd8QpLzXw",
"customer": {
"type": "RfndCustomerAttributes",
"customerId": "cust_9f2Kd8QpLzXw",
"name": "Ada Lovelace",
"emailAddress": "ada@example.com",
"phoneNumber": "+61400000000"
},
"orderId": "ordr_9f2Kd8QpLzXw",
"referenceOrderId": "your-own-reference",
"paymentType": "PayInFull",
"status": "Accepted",
"amounts": {
"type": "TranAmountsAttributes",
"currency": "AUD",
"amount": 1250,
"surcharge": 1250,
"refunded": 1250,
"fee": 1250
},
"refunds": [
{
"type": "RfndViewAttributes",
"refundId": "rfnd_9f2Kd8QpLzXw",
"subject": {
"type": "RfndSubjectTransaction",
"transactionId": "tran_9f2Kd8QpLzXw"
},
"merchantId": "mcht_9f2Kd8QpLzXw",
"customer": {
"type": "RfndCustomerAttributes",
"customerId": "cust_9f2Kd8QpLzXw",
"name": "Ada Lovelace",
"emailAddress": "ada@example.com",
"phoneNumber": "+61400000000"
},
"status": "Pending",
"amounts": {
"type": "RfndAmountsAttributes",
"currency": "AUD",
"amount": 1250,
"transactionAmount": 1250
},
"orderId": "ordr_9f2Kd8QpLzXw",
"referenceOrderId": "your-own-reference",
"orderMetadata": {
"yourKey": {}
},
"payoutId": "payout_9f2Kd8QpLzXw",
"settlementDate": "2026-08-19",
"attempts": 1250,
"lastError": "string",
"createdAt": "2026-08-19T04:21:07Z",
"refundedAt": "2026-08-19T04:21:07Z",
"updatedAt": "2026-08-19T04:21:07Z"
}
],
"disputes": [
{
"type": "DisputeViewAttributes",
"disputeId": "dispute_9f2Kd8QpLzXw",
"subject": {
"type": "RfndSubjectTransaction",
"transactionId": "tran_9f2Kd8QpLzXw"
},
"merchantId": "mcht_9f2Kd8QpLzXw",
"customer": {
"type": "RfndCustomerAttributes",
"customerId": "cust_9f2Kd8QpLzXw",
"name": "Ada Lovelace",
"emailAddress": "ada@example.com",
"phoneNumber": "+61400000000"
},
"status": "Pending",
"gatewayState": "string",
"amounts": {
"type": "DisputeAmountsAttributes",
"currency": "AUD",
"amount": 1250,
"transactionAmount": 1250
},
"feeAmount": {
"type": "IsoCurrencyAmount",
"minorCurrencyUnits": 1250,
"currency": "AUD"
},
"reason": "Requested by the customer.",
"description": "string",
"orderId": "ordr_9f2Kd8QpLzXw",
"referenceOrderId": "your-own-reference",
"orderMetadata": {
"yourKey": {}
},
"evidenceDueBy": "2026-08-19",
"createdAt": "2026-08-19T04:21:07Z",
"updatedAt": "2026-08-19T04:21:07Z"
}
],
"payoutId": "payout_9f2Kd8QpLzXw",
"settlementDate": "2026-08-19",
"availableOn": "2026-08-19",
"referenceTransactionId": "your-own-reference",
"referenceIssuerTransactionId": "your-own-reference",
"createdAt": "2026-08-19T04:21:07Z",
"updatedAt": "2026-08-19T04:21:07Z"
}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"
}