Create reports
/reportsRun a report. The answer is the report, nothing is stored, so keep it. Each report is authorised as the collection it reports on is.
RprtCmdPayoutRprtCmdRefundsRprtCmdSettlementRprtCmdTransactionsPermissions
Required action depends on the request variant. Select a variant in the request body below to see the permission it requires.
Request body
This body is a typed union. Pick a variant to see its fields, the permission it requires, and a matching example.
typetype = "RprtCmdPayout"Report, and email, one payout
merchantIdMchtIdThe payout's merchant. Omit it, the payout names it.
Example mcht_9f2Kd8QpLzXw
payoutIdPayoutIdrequiredIdentifier of a payout.
Example payout_9f2Kd8QpLzXw
emailToarray of stringAlso email the report to these addresses. The platform does not report send failures.
Example ada@example.com
includeSettlementReportbooleanAttach the settlement report to that email as well. Only meaningful with emailTo.
Example true
curl -X POST https://api.tst.au.apgpay.dev/reports \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "RprtCmdPayout",
"merchantId": "mcht_9f2Kd8QpLzXw",
"payoutId": "payout_9f2Kd8QpLzXw",
"emailTo": [
"ada@example.com"
],
"includeSettlementReport": true
}'Responses
The response is a tagged shape: type is always "RprtCreateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "RprtCreateRspAttributes"The resource that was created.
typeOne payout's payments and refunds, with the fee totals the payout itself does not carry.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
payoutIdPayoutIdrequiredIdentifier of a payout.
Example payout_9f2Kd8QpLzXw
facilitationstringrequiredWho facilitates the payment, the platform's own funds flow, or a connected gateway account.
What a payout's contents came to. All in the single currency given here.
typeenumrequiredRprtPayoutAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
payoutMinorUnitsThe payout itself, as the platform recorded it. Absent on a payout that has not been valued.
Example 1250
grossMinorUnitsrequiredBefore fees, netting refunds off.
Example 1250
netMinorUnitsrequiredAfter fees.
Example 1250
feesInclTaxMinorUnitsrequiredPlatform fees, including tax.
Example 1250
feesTaxMinorUnitsrequiredThe tax within those fees.
Example 1250
createdAtstring (date-time)requiredWhen the payout was raised.
Example 2026-08-19T04:21:07Z
arrivedAtstring (date-time)When the destination bank acknowledged the funds.
Example 2026-08-19T04:21:07Z
emailedToarray of stringWhere the report was emailed. Empty unless emailTo was given on the request.
Example ada@example.com
typeenumrequiredRprtPaymentRowAttributesdirectionstringrequiredPayment or Refund. The platform signs the totals by this.
transactionIdTranIdThe transaction this row is for, where there is one.
Example tran_9f2Kd8QpLzXw
orderReferencestringThe merchant's own order reference.
Example your-own-reference
paymentTypestringWhat kind of payment it was.
netMinorUnitsrequiredWhat reached the merchant.
Example 1250
feeInclTaxMinorUnitsrequiredThe platform fee, including tax.
Example 1250
feeTaxMinorUnitsrequiredThe tax within that fee.
Example 1250
customFieldsmap of stringValues the merchant defined for its own order reporting.
atstring (date-time)requiredExample 2026-08-19T04:21:07Z
Refunds over a period: how many, and a flattened row for each.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
totalinteger (int64)requiredExample 1250
typeenumrequiredRprtRefundRowAttributesrefundIdstringrequiredExample rfnd_9f2Kd8QpLzXw
transactionIdTranIdThe transaction refunded, where the refund is of one.
Example tran_9f2Kd8QpLzXw
orderReferencestringThe merchant's own order reference.
Example your-own-reference
customerEmailstringExample ada@example.com
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
amountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
payoutIdPayoutIdThe payout the refund was deducted from.
Example payout_9f2Kd8QpLzXw
paidOutAtstring (date-time)Example 2026-08-19T04:21:07Z
paidOutAmountMinorUnitsAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
atstring (date-time)requiredWhen the refund was made.
Example 2026-08-19T04:21:07Z
A merchant's settlement over a period or for one payout, with the aggregates and the payout it settled.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
What a settlement period came to. All in the single currency given here.
typeenumrequiredRprtSettlementAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
grossMinorUnitsrequiredBefore platform fees.
Example 1250
netMinorUnitsrequiredAfter them, what settles to the merchant.
Example 1250
feesInclTaxMinorUnitsrequiredPlatform fees, including tax.
Example 1250
feesTaxMinorUnitsrequiredThe tax within those fees.
Example 1250
The payout this settlement produced, where the report is of one.
typeenumrequiredRprtSettlementPayoutAttributespayoutIdPayoutIdrequiredIdentifier of a payout.
Example payout_9f2Kd8QpLzXw
referencestringThe reference the merchant sees against the deposit.
Example your-own-reference
statusstringrequiredExample Active
settlementTypeMchtSettlementTyperequiredNetGrossUnknowncurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
amountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
openingBalanceMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
closingBalanceMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
activeFromstring (date-time)The earliest entry the payout covers.
Example 2026-08-19T04:21:07Z
activeTostring (date-time)The latest entry the payout covers.
Example 2026-08-19T04:21:07Z
paidOnstring (date)The day the funds were paid.
Example 2026-08-19
failureReasonstringWhy the payout failed, where it did.
Example Requested by the customer.
totalRecordsinteger (int64)requiredRows in the report. The platform's own count.
Example 1250
includedColumnsarray of stringWhich columns the merchant's settings say to include. A row still carries every field; this says which the merchant asked for.
createdAtstring (date-time)requiredWhen the report was produced.
Example 2026-08-19T04:21:07Z
typeenumrequiredRprtSettlementRowAttributesentryDatestring (date)requiredThe day the entry was made.
Example 2026-08-19
entryAtstring (date-time)requiredThe instant it was made.
Example 2026-08-19T04:21:07Z
entryTypestringrequiredWhat kind of movement, the platform's vocabulary, which grows.
descriptionstringWhat the entry is, in words.
settlementDatestring (date)The day it settles.
Example 2026-08-19
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
merchantNamestringrequiredBusiness name of the merchant, so a spreadsheet reads without a second call.
Example Ada Lovelace
cardHolderNamestringThe name on the card, where the entry came from a card payment.
Example Ada Lovelace
cardNumberstringThe masked card number, where it did.
transactionTypestringWhat kind of transaction it was.
orderTypestringWhat kind of order it came from.
orderReferencestringThe merchant's own order reference.
Example your-own-reference
orderDescriptionstringWhat the order was for.
orderMetadatamap of any JSON valueFree-form data carried from the order.
orderIdstringExample ordr_9f2Kd8QpLzXw
transactionIdTranIdIdentifier of a transaction.
Example tran_9f2Kd8QpLzXw
refundIdstringExample rfnd_9f2Kd8QpLzXw
payoutIdPayoutIdThe payout this entry landed in.
Example payout_9f2Kd8QpLzXw
payoutReferencestringThe reference the merchant sees against that payout.
Example your-own-reference
billingCategorystringThe merchant's billing category for this entry.
feeSummarystringHow the fees on this entry were arrived at, as the platform prints it.
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
transactionAmountMinorUnitsThe transaction's own amount, where the entry relates to one.
Example 1250
grossMinorUnitsrequiredBefore fees.
Example 1250
netMinorUnitsrequiredAfter them.
Example 1250
feesInclTaxMinorUnitsrequiredPlatform fees, including tax.
Example 1250
feesTaxMinorUnitsrequiredThe tax within those fees.
Example 1250
customFieldsmap of stringValues the merchant defined for its own reporting.
Transactions over a period: how many, and a flattened row for each.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
totalinteger (int64)requiredTransactions in the period. This is the platform's own count, not the length of rows.
Example 1250
typeenumrequiredRprtTransactionRowAttributestransactionIdTranIdrequiredIdentifier of a transaction.
Example tran_9f2Kd8QpLzXw
orderReferencestringThe merchant's own order reference, where the transaction came from an order.
Example your-own-reference
customerEmailstringThe customer's email, from the customer record or the order.
Example ada@example.com
customerNamestringThe customer's name, where the platform has one.
Example Ada Lovelace
paymentTypestringrequiredWhat kind of payment, the platform's vocabulary, which grows.
orderTypestringWhat kind of order it came from, where it came from one.
statusstringrequiredExample Active
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
amountMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
surchargeMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
refundedMinorUnitsrequiredAn amount in the minor units of the currency given by the enclosing object's currency field.
Example 1250
The platform fee on this transaction and how it was arrived at.
typeenumrequiredRprtFeeAttributestotalMinorUnitsrequiredThe fee charged, including tax.
Example 1250
fixedMinorUnitsrequiredThe fixed component.
Example 1250
percentagestringrequiredThe percentage component, as a decimal, 0.0175 is 1.75%.
taxMinorUnitsrequiredThe tax within the fee.
Example 1250
payoutIdPayoutIdThe payout that carried this transaction to the merchant.
Example payout_9f2Kd8QpLzXw
paidOutAtstring (date-time)When that payout was made.
Example 2026-08-19T04:21:07Z
paidOutAmountMinorUnitsHow much of this transaction was in that payout.
Example 1250
atstring (date-time)requiredWhen the transaction was taken.
Example 2026-08-19T04:21:07Z
{
"type": "RprtCreateRspAttributes",
"created": {
"type": "RprtViewPayout",
"merchantId": "mcht_9f2Kd8QpLzXw",
"payoutId": "payout_9f2Kd8QpLzXw",
"facilitation": "string",
"amounts": {
"type": "RprtPayoutAmountsAttributes",
"currency": "AUD",
"payout": 1250,
"gross": 1250,
"net": 1250,
"feesInclTax": 1250,
"feesTax": 1250
},
"createdAt": "2026-08-19T04:21:07Z",
"arrivedAt": "2026-08-19T04:21:07Z",
"emailedTo": [
"ada@example.com"
],
"rows": [
{
"type": "RprtPaymentRowAttributes",
"direction": "string",
"transactionId": "tran_9f2Kd8QpLzXw",
"orderReference": "your-own-reference",
"paymentType": "string",
"net": 1250,
"feeInclTax": 1250,
"feeTax": 1250,
"customFields": {
"yourKey": "string"
},
"at": "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"
}