Create orders
/ordersCreate an order, optionally with a payment link. Selected by the body's type.
OrdrCmdCreateOrdrCmdCreateInvoicePermissions
orders:createRequires the `create` action on `orders` for the supplied runtime context
Request body
This body is a typed union. Pick a variant to see its fields and a matching example.
typetype = "OrdrCmdCreate"The order to create.
typeenumrequiredOrdrNewOrderAttributesmerchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
customerIdCustIdThe customer this order is for, where there is one. Used to authorise the create; the order itself records the payer by name and email.
Example cust_9f2Kd8QpLzXw
orderTypeOrdrTyperequiredOnlineManualInvoiceUnknownreferenceOrderIdstringrequiredYour own reference for this order.
Example your-own-reference
descriptionstringrequiredWhat the order is for. Shown to the payer.
amountMinorUnitsrequiredThe order total before any surcharge.
Example 1250
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
Who is paying, and where. Required, the platform will not create an order without it.
typeenumrequiredOrdrBillingAttributesnamestringrequiredExample Ada Lovelace
A postal address.
typeenumrequiredOrdrAddressAttributesline1stringrequiredline2stringcitystringrequiredstatestringrequiredpostalCodestringrequiredExample 3000
countryIsoCountryrequiredAFAXALDZASADAOAIAQAG+239 moreShow fewer
AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, KP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, CD, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, VI, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
phonestringExample +61400000000
emailAddressstringThe payer's email address.
Example ada@example.com
phoneNumberstringThe payer's phone number, in E.164.
Example +61400000000
The product lines on the order. Invoice lines are written by the platform when a payment link is issued.
typeenumrequiredOrdrNewLineItemAttributesdescriptionstringrequiredquantitynumberrequiredHow many. Fractional quantities are allowed.
Example 12.5
amountMinorUnitsrequiredPrice of the line, in the order's currency.
Example 1250
skustringYour own stock-keeping code for the item.
imageUrlstringAn image of the item, to show at checkout.
Example https://example.com/callback
taxIncludedbooleanWhether tax is included in amount. When it is, the tax is worked out at the merchant country's standard rate unless you override it.
Example true
taxAmountMinorUnitsOverride the tax within amount, in the order's currency.
Example 1250
discountMinorUnitsA discount applied to the order total, in the order's currency.
Example 1250
Where an order is being shipped, and how.
typeenumrequiredOrdrShippingAttributesnamestringrequiredWho the goods are going to.
Example Ada Lovelace
A postal address.
typeenumrequiredOrdrAddressAttributesline1stringrequiredline2stringcitystringrequiredstatestringrequiredpostalCodestringrequiredExample 3000
countryIsoCountryrequiredAFAXALDZASADAOAIAQAG+239 moreShow fewer
AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, KP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, CD, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, VI, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
amountMinorUnitsThe shipping charge, in the order's currency.
Example 1250
carrierstringWho is carrying it.
trackingNumberstringThe carrier's tracking number.
phonestringExample +61400000000
request3DSOnPaymentbooleanRequire a 3DS challenge when this order is paid.
Example true
emailCustomerReceiptbooleanEmail the payer a receipt when the order is paid.
Example true
settlementOrdrSettlementWhether payments for this order use real-time settlement.
DefaultStandardRealtimePreferredRealtimeRequiredUnknownmetadatamap of any JSON valueFree-form data the platform stores and returns untouched. Values may be nested objects and arrays.
curl -X POST https://api.tst.au.apgpay.dev/orders \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "OrdrCmdCreate",
"order": {
"type": "OrdrNewOrderAttributes",
"merchantId": "mcht_9f2Kd8QpLzXw",
"customerId": "cust_9f2Kd8QpLzXw",
"orderType": "Online",
"referenceOrderId": "your-own-reference",
"description": "string",
"amount": 1250,
"currency": "AUD",
"billing": {
"type": "OrdrBillingAttributes",
"name": "Ada Lovelace",
"address": {
"type": "OrdrAddressAttributes",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "3000",
"country": "AU"
},
"phone": "+61400000000"
},
"emailAddress": "ada@example.com",
"phoneNumber": "+61400000000",
"lineItems": [
{
"type": "OrdrNewLineItemAttributes",
"description": "string",
"quantity": 12.5,
"amount": 1250,
"sku": "string",
"imageUrl": "https://example.com/callback"
}
],
"taxIncluded": true,
"taxAmount": 1250,
"discount": 1250,
"shipping": {
"type": "OrdrShippingAttributes",
"name": "Ada Lovelace",
"address": {
"type": "OrdrAddressAttributes",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "3000",
"country": "AU"
},
"amount": 1250,
"carrier": "string",
"trackingNumber": "string",
"phone": "+61400000000"
},
"request3DSOnPayment": true,
"emailCustomerReceipt": true,
"settlement": "Default",
"metadata": {
"yourKey": {}
}
}
}'Responses
The response is a typed union.
typetype = "OrdrCreateRspInvoice"An order, the commerce record a payment settles.
typeenumrequiredOrdrViewAttributesorderIdOrdrIdrequiredIdentifier of an order.
Example ordr_9f2Kd8QpLzXw
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
marketplaceIdMktpIdThe marketplace the merchant trades under, where it does.
Example mktp_9f2Kd8QpLzXw
Who is paying.
typeenumrequiredOrdrCustomerAttributesnamestringThe payer's billing name, or their email address where there is no billing name.
Example Ada Lovelace
emailAddressstringMasked unless your credential may read order PII.
Example ada@example.com
phoneNumberstringMasked unless your credential may read order PII. E.164.
Example +61400000000
statusOrdrStatusrequiredCreatedAcceptedPaidCancelledFulfilledReturnedUnknownorderTypeOrdrTyperequiredWhat kind of order this is.
OnlineManualInvoiceUnknownThe amounts on an order. All are in the single currency given here.
typeenumrequiredOrdrAmountsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
totalMinorUnitsrequiredThe order total before any surcharge, what goes on the invoice.
Example 1250
taxMinorUnitsTax within the total, where the order states tax is included.
Example 1250
paidMinorUnitsWhat has actually been paid, surcharge included. Absent until the order is paid.
Example 1250
outstandingMinorUnitsrequiredStill owing, the total less what has been paid.
Example 1250
surchargeMinorUnitsrequiredThe surcharge the payment method used added, where one was. Zero until the order is paid.
Example 1250
discountMinorUnitsA discount applied to the order total.
Example 1250
The product lines on the order.
typeAn invoice line, something being billed, with its own tax.
descriptionstringrequiredWhat the line is for.
unitCountnumberrequiredHow many units, fractional allowed.
Example 12.5
feeMinorUnitsrequiredThe fee charged on this line, in the order's currency.
Example 1250
taxMinorUnitsrequiredTax charged on this line, in the order's currency.
Example 1250
valueMinorUnitsThe value of what is being billed for, where it differs from the fee.
Example 1250
categorystringHow the line is classified on the invoice.
notesstringFree text shown against the line.
A product line, something being sold, with a price per unit.
descriptionstringrequiredquantitynumberrequiredHow many. Fractional quantities are allowed, because an hour and a half is a quantity.
Example 12.5
amountMinorUnitsrequiredPrice of the line, in the order's currency.
Example 1250
skustringYour own stock-keeping code for the item.
imageUrlstringAn image of the item, to show at checkout.
Example https://example.com/callback
descriptionstringWhere the goods go. Absent unless your credential may read order PII.
typeenumrequiredOrdrShippingAttributesnamestringrequiredWho the goods are going to.
Example Ada Lovelace
A postal address.
typeenumrequiredOrdrAddressAttributesline1stringrequiredline2stringcitystringrequiredstatestringrequiredpostalCodestringrequiredExample 3000
countryIsoCountryrequiredAFAXALDZASADAOAIAQAG+239 moreShow fewer
AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, KP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, CD, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, VI, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
amountMinorUnitsThe shipping charge, in the order's currency.
Example 1250
carrierstringWho is carrying it.
trackingNumberstringThe carrier's tracking number.
phonestringExample +61400000000
Who is paying, and where. Absent unless your credential may read order PII.
typeenumrequiredOrdrBillingAttributesnamestringrequiredExample Ada Lovelace
A postal address.
typeenumrequiredOrdrAddressAttributesline1stringrequiredline2stringcitystringrequiredstatestringrequiredpostalCodestringrequiredExample 3000
countryIsoCountryrequiredAFAXALDZASADAOAIAQAG+239 moreShow fewer
AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, KP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, CD, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, VI, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
phonestringExample +61400000000
settlementOrdrSettlementWhether payments for this order use real-time settlement.
DefaultStandardRealtimePreferredRealtimeRequiredUnknownrequest3DSOnPaymentbooleanrequiredWhether a 3DS challenge is required when this order is paid.
Example true
emailCustomerReceiptbooleanrequiredWhether the payer is emailed a receipt.
Example true
referenceOrderIdstringrequiredYour own reference for this order. Required at creation, so always present.
Example your-own-reference
metadatamap of any JSON valueFree-form data. Absent unless your credential may read order PII.
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
A link that lets its bearer pay an order without any other credential.
typeenumrequiredOrdrPaymentLinkAttributestokenstringrequiredThe token itself. Returned when the link is issued, and never on a read, treat it as a secret.
Example tok_9f2Kd8QpLzXwR4mN
urlstringThe URL to send the payer, where the platform generated one.
Example https://example.com/callback
{
"type": "OrdrCreateRspInvoice",
"created": {
"type": "OrdrViewAttributes",
"orderId": "ordr_9f2Kd8QpLzXw",
"merchantId": "mcht_9f2Kd8QpLzXw",
"marketplaceId": "mktp_9f2Kd8QpLzXw",
"customer": {
"type": "OrdrCustomerAttributes",
"name": "Ada Lovelace",
"emailAddress": "ada@example.com",
"phoneNumber": "+61400000000"
},
"status": "Created",
"orderType": "Online",
"amounts": {
"type": "OrdrAmountsAttributes",
"currency": "AUD",
"total": 1250,
"tax": 1250,
"paid": 1250,
"outstanding": 1250,
"surcharge": 1250,
"discount": 1250
},
"lineItems": [
{
"type": "OrdrLineItemInvoice",
"description": "string",
"unitCount": 12.5,
"fee": 1250,
"tax": 1250,
"value": 1250,
"category": "string",
"notes": "string"
}
],
"description": "string",
"shipping": {
"type": "OrdrShippingAttributes",
"name": "Ada Lovelace",
"address": {
"type": "OrdrAddressAttributes",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "3000",
"country": "AU"
},
"amount": 1250,
"carrier": "string",
"trackingNumber": "string",
"phone": "+61400000000"
},
"billing": {
"type": "OrdrBillingAttributes",
"name": "Ada Lovelace",
"address": {
"type": "OrdrAddressAttributes",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "3000",
"country": "AU"
},
"phone": "+61400000000"
},
"settlement": "Default",
"request3DSOnPayment": true,
"emailCustomerReceipt": true,
"referenceOrderId": "your-own-reference",
"metadata": {
"yourKey": {}
},
"createdAt": "2026-08-19T04:21:07Z",
"updatedAt": "2026-08-19T04:21:07Z"
},
"paymentLink": {
"type": "OrdrPaymentLinkAttributes",
"token": "tok_9f2Kd8QpLzXwR4mN",
"url": "https://example.com/callback"
}
}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"
}