List merchants
/merchantscurl -X GET https://api.tst.au.apgpay.dev/merchants \
-H "Authorization: Bearer $API_KEY"Return a page of merchants. Supply page for offset pagination or startingAfter for cursor pagination, and q to search. With q the merchants page by page only: startingAfter and endingBefore are refused with 400, and so are several marketplaceId or enterpriseId values or either left out. GET /filter-catalogues/merchants lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400.
Permissions
merchants:queryRequires the `query` action on `merchants` for the supplied runtime context
Query parameters
qstringFree-text search. Supplying it engages the search index; omit it to filter only.
pageinteger (int32)Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.
startingAfterstringCursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.
endingBeforestringCursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.
limitinteger (int32)Maximum items per page.
sortarray of MchtSortFields to sort by, comma-delimited, in priority order. Prefix a field with - for descending.
columnsarray of MchtColumnColumns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.
statusone of MchtStatus, array of MchtStatusOnly merchants whose status is one of these. Repeat the parameter to give several.
referenceMerchantIdone of array of string, stringOnly merchants whose merchant reference is one of these. Repeat the parameter to give several.
marketplaceIdone of array of string, stringOnly merchants whose marketplace is one of these. Repeat the parameter to give several.
marketplaceIdNotone of array of string, stringLeave out merchants whose marketplace is one of these. Repeat the parameter to give several.
enterpriseIdone of array of string, stringOnly merchants whose enterprise is one of these. Repeat the parameter to give several.
enterpriseIdNotone of array of string, stringLeave out merchants whose enterprise is one of these. Repeat the parameter to give several.
payoutsEnabledbooleanOnly merchants with payouts turned on, or only those with them turned off. Reads payoutSettings.payoutsEnabled.
createdAfterstring (date-time)Only merchants whose creation time is at or after this ISO-8601 timestamp.
createdBeforestring (date-time)Only merchants whose creation time is at or before this ISO-8601 timestamp.
Responses
The response is a tagged shape: type is always "MchtPageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "MchtPageAttributes"typeA merchant that sells: takes payments, settles, and is paid out.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
organisationIdOrgIdrequiredThe organisation this merchant is, its legal record, read at GET /organisations/{organisationId}.
Example org_9f2Kd8QpLzXw
referenceMerchantIdstringThe caller's own identifier for this merchant, if one was supplied.
Example your-own-reference
slugstringrequiredURL-safe identifier used for hosted pages.
statusMchtStatusrequiredOnboardingOnboardingReviewActiveCheckoutDisabledSuspendedClosedUnknownThe outcome of verifying the business. Absent unless the principal may read merchant state.
typeenumrequiredMchtVerificationAttributesstatusMchtVerificationStatusrequiredPendingVerifiedUnknownerrorCodesarray of stringWhy verification has not completed, as platform onboarding error codes.
detailsarray of stringHuman-readable detail behind the error codes.
The trading identity of a merchant.
typeenumrequiredMchtBusinessAttributeslegalNamestringrequiredRegistered legal name of the business.
Example Ada Lovelace
brandNamestringName the business trades under, where it differs from the legal name. Taken on MchtCmdCreateSupplier; on MchtCmdCreate the platform's create has nowhere to put it, so set it afterwards with MchtUpdateBusinessProfile.
Example Ada Lovelace
businessRegistrationNumberstringABN in Australia, NZBN in New Zealand. Checked against country.
taxRegistrationNumberstringABN in Australia, IRD number in New Zealand. Checked against country, and given only with businessRegistrationNumber; in Australia it must be that same ABN. Read back as the business registration number in Australia when none was given.
countrystringrequiredExample AU
websitestringTaken on MchtCmdCreateSupplier; on MchtCmdCreate the platform's create has nowhere to put it, so set it afterwards with MchtUpdateBusinessProfile.
contactEmailstringrequiredExample ada@example.com
timeZonestringrequiredHow the business presents to a payer.
typeenumrequiredMchtPublicProfileAttributesbrandNamestringThe customer-facing name of the business.
Example Ada Lovelace
cardStatementNamestringWhat appears on a card statement. Letters, numbers and spaces only.
Example Ada Lovelace
smsSenderNamestringSender name on SMS. Letters and digits only.
Example Ada Lovelace
websitestringsupportSitestringWho to contact at the business.
typeenumrequiredMchtContactAttributesfirstNamestringExample Ada Lovelace
lastNamestringExample Ada Lovelace
titlestringcontactEmailstringExample ada@example.com
supportEmailstringExample ada@example.com
phoneNumberstringE.164 format, e.g. +61400000000.
Example +61400000000
A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one.
typeenumrequiredMchtAddressAttributesunitNumberstringUnit, shop or level, as written on the building. Free text, 12, Shop 4, Level 3. Omit where there is none.
streetNumberstringrequiredStreet number, including any range or letter, 34, 34A, 34-36.
streetNamestringrequiredStreet name, without the type, Smith, not Smith Street.
Example Ada Lovelace
streetTypestringStreet, Road, Avenue. Optional because not every address has one.
suburbstringSuburb. This is where Australia and South Africa keep what other countries call the city.
citystringCity. Required in New Zealand. In Australia and South Africa send suburb instead, the platform moves whichever you send to where that country keeps it.
statestringState, province or territory. Required in Australia.
postalCodestringrequiredExample 3000
countrystringrequiredISO 3166-1 alpha-2.
Example AU
When and how the merchant is paid out.
typeenumrequiredMchtPayoutSettingsAttributesscheduleMchtPayoutScheduleDailyWeeklyFortnightlyMonthlyUnknowndayOfWeekstringRequired when schedule is Weekly.
dayOfMonthinteger (int32)Required when schedule is Monthly.
Example 6
delayDaysinteger (int32)Business days to hold funds beyond the schedule before paying out: one to four.
Example 1250
statementDescriptorstringDefault reference on the payout, where the bank shows one.
Example ADA COFFEE
payoutsEnabledbooleanTurn payouts off without changing the schedule.
Example true
automatedPayoutsEnabledbooleanRead-only. Whether the platform raises payouts on the schedule, or the merchant asks for each one.
Example true
automatedDisbursementsEnabledbooleanRead-only. Whether the platform sends the money, or someone pays it out of band and records it afterwards. This is what decides whether PayoutUpdateRecordManualPayment is accepted.
Example true
notificationEmailsarray of stringExample ada@example.com
remitterNamestringThe party named as the remitter on outgoing payments, where it differs from the merchant.
Example Ada Lovelace
How the merchant is billed for platform fees.
typeenumrequiredMchtBillingSettingsAttributesnotificationEmailsarray of stringExample ada@example.com
notificationsEnabledbooleanExample true
A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one.
typeenumrequiredMchtAddressAttributesunitNumberstringUnit, shop or level, as written on the building. Free text, 12, Shop 4, Level 3. Omit where there is none.
streetNumberstringrequiredStreet number, including any range or letter, 34, 34A, 34-36.
streetNamestringrequiredStreet name, without the type, Smith, not Smith Street.
Example Ada Lovelace
streetTypestringStreet, Road, Avenue. Optional because not every address has one.
suburbstringSuburb. This is where Australia and South Africa keep what other countries call the city.
citystringCity. Required in New Zealand. In Australia and South Africa send suburb instead, the platform moves whichever you send to where that country keeps it.
statestringState, province or territory. Required in Australia.
postalCodestringrequiredExample 3000
countrystringrequiredISO 3166-1 alpha-2.
Example AU
paymentSourceIdstringThe payment source platform fees are charged to.
Example psrc_9f2Kd8QpLzXw
Logo, colours and the look of hosted pages.
typeenumrequiredMchtBrandingAttributeslogoFileIdstringExample lfile_9f2Kd8QpLzXw
iconFileIdstringExample lfile_9f2Kd8QpLzXw
logoAltTextstringbrandColourstringHex, e.g. #0B7285.
What the merchant collects on an order, and who is told about it.
typeenumrequiredMchtOrderSettingsAttributesExtra fields captured against an order. Sending the list replaces it.
typeenumrequiredMchtOrderCustomFieldAttributeskeystringrequiredThe key the value is stored and reported under.
labelstringrequiredWhat the field is called on the order form.
requiredbooleanrequiredWhether the merchant must supply a value when raising a pay-by-link order.
Example true
visibleToPayerbooleanrequiredWhether the field appears on order views and communications sent to the payer.
Example true
notificationEmailsarray of stringExample ada@example.com
notifyOnPaidbooleanEmail the merchant when an order is paid.
Example true
The platform's source rules for this merchant: what it is charged, what it surcharges, and what it may accept.
typeenumrequiredMchtRuleAttributestypeAlways matches. Use it for the fallback rule.
Always matches. Use it for the fallback rule.
Matches when every nested criterion matches.
criteriaarray of MchtRuleCriterionrequiredMatches cards in any of these BIN groups.
binGroupIdsarray of MchtBinGroupIdrequiredExample bing_9f2Kd8QpLzXw
Matches this card brand.
cardBrandCardBrandrequiredVisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
Matches cards with this funding source.
cardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknownMatches prepaid cards, or matches everything but them.
isPrepaidbooleanrequiredExample true
Matches payments in this 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
Matches payments by this kind of customer.
customerTypeMchtRuleCustomerTyperequiredConsumerOrganisationUnknownMatches cards issued in this country.
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
Matches this payment method.
methodTypeMchtRuleMethodTyperequiredCardDirectDebitBankTransferPayToUnknownMatches this pay-plan variant.
payPlanVariantMchtRulePayPlanVariantrequiredFortnightly4Weekly4Weekly8Fortnightly26Weekly52Monthly2Monthly3Monthly4Monthly5Monthly6+11 moreShow fewer
Monthly7, Monthly8, Monthly9, Monthly10, Monthly11, Monthly12, FortnightlyDeferred, Weekly4Deferred, Weekly7Deferred, Days30Deferred, Unknown
Matches this way of paying.
payTypeMchtRulePayTyperequiredPayCardPayPlanUnknownMatches cards of this product type.
productTypeCardProductTyperequiredConsumerCorporateUnknownMatches cards of this scheme product.
schemeProductCardSchemeProductrequiredMasterCardCrPerMasterCardSigniaMasterCardDrPerIntMasterCardWorldAllStarAmericanExpressVisaCreditPersonalVisaDrPerIntDinersClubDiscoverDinersCreditComEEA+43 moreShow fewer
DinersInternational, DinersCreditPerEEA, DinersDebitComEEA, DinersDebitPerEEA, VisaDebitPersonal, VisaDebitCom, DrMasterCardPer, DrMasterCardCom, DebitMasterCardPerInt, EFTPOSPriority1, EFTPOSPriority2, JCB, JCBCreditComEEA, JCBInternational, JCBCreditPerEEA, JCBDebitComEEA, JCBDebitPerEEA, Keyfuels, LaSer, Overdrive, VisaElectronDr, VisaElectronCr, VisaElecPerInt, MaestroPer, MaestroCom, MaestroPer2, MaestroIntlCom, MaestroIntlPer, Supercharge, Sears, MasterCardComm, MasterCardBusiness, MasterCardFleet, MasterCardCorporate, MasterCardPurchase, MasterCardDrCom, VisaBusiness, VisaCommerce, VisaCorporate, VisaPurchasing, VisaDrComIntl, UATP, Unknown
Matches when the nested criterion does not.
criterionMchtRuleCriterionrequiredThe same shape as data[].MchtViewStandard.sourceRules[].criterion, shown above.
Matches when any nested criterion matches.
criteriaarray of MchtRuleCriterionrequiredEvery action to take when the criterion matches. At least one.
typeAllow payments matching the criterion.
Allow payments matching the criterion.
Refuse payments matching the criterion.
Refuse payments matching the criterion.
Charge the merchant a platform fee of this shape.
fixedMinorUnitsrequiredA fixed amount, in the minor units of the payment's currency.
Example 1250
ratenumberrequiredA rate applied to the payment amount, as a decimal fraction, 0.0175 is 1.75%.
Example 0.9412
Pass a surcharge of this shape to the payer.
fixedMinorUnitsrequiredA fixed amount, in the minor units of the payment's currency.
Example 1250
ratenumberrequiredA rate applied to the payment amount, as a decimal fraction, 0.0175 is 1.75%.
Example 0.9412
Pass on exactly the platform fee this payment attracts.
Pass on exactly the platform fee this payment attracts.
Pass on a multiple of the platform fee this payment attracts.
multipliernumberrequired1.0 passes on exactly the platform fee; 1.1 passes on ten per cent more.
Example 12.5
What the merchant will and will not accept.
typeenumrequiredMchtUsageRulesAttributestypeOnly these currencies are accepted. Everything else is refused.
currenciesarray of IsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
These currencies are refused. Everything else is accepted.
currenciesarray of IsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
typeOnly cards issued in these countries are accepted.
countriesarray of IsoCountryrequiredAFAXALDZASADAOAIAQAG+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
Cards issued in these countries are refused.
countriesarray of IsoCountryrequiredAFAXALDZASADAOAIAQAG+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
Risk, settlement and verification policy for a merchant.
typeenumrequiredMchtRiskSettingsAttributessettlementTypeMchtSettlementTypeNet rolls platform fees into each payout; Gross invoices them separately.
NetGrossUnknownbankAccountVerificationRequiredbooleanWhether a bank account must be verified before it can be used.
Example true
Which verification outcomes are accepted, and whether the outcome is returned to the caller.
typeenumrequiredMchtVerificationPolicyAttributesacceptarray of MchtVerificationOutcomeOutcomes that let the account be used. Anything else is refused. Failed and Unknown cannot be accepted and are ignored if sent: what happens when the bank cannot answer is the platform's decision, not a merchant's.
MatchPartialMatchNoMatchAccountClosedFailedUnknownincludeResultInResponsebooleanReturn the verification outcome to the caller. Off by default, because it is the bank's assessment of a person.
Example true
sourceVerificationEnabledbooleanAsk a payer to confirm a small debit before their source is used, 3DS's belt and braces.
Example true
supportedCustomerTypesarray of MchtCustomerTypeWhich kinds of customer this merchant sells to.
ConsumerOrganisationUnknownThe band of payment sizes the checkout will accept.
typeenumrequiredMchtPaymentLimitsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
minimumPaymentAmountMinorUnitsSmallest payment the checkout will accept.
Example 1250
maximumPaymentAmountMinorUnitsLargest payment the checkout will accept.
Example 1250
disputesWaivedbooleanDo not charge this merchant for disputes.
Example true
payoutPriorityinteger (int32)Higher values are paid out ahead of lower ones.
Example 10
showPlatformLogoInTermsbooleanShow the platform's logo on the terms page shown to payers.
Example true
showSavedPaymentMethodsInCheckoutbooleanOffer the payer their saved payment sources in the checkout.
Example true
showReferenceOrderIdToCustomerbooleanShow the merchant's own order reference on communications to the payer.
Example true
emailPaymentReceiptbooleanEmail the payer a receipt when an order is paid.
Example true
emailPaymentFailurebooleanEmail the payer after a failed attempt.
Example true
Bank accounts the merchant can be paid out to.
typeenumrequiredMchtBankAccountAttributesexternalAccountIdstringrequiredExample xacc_9f2Kd8QpLzXw
accountNamestringrequiredExample Ada Lovelace
last4stringrequiredLast four digits of the account number.
Example 4242
currencystringrequiredExample AUD
isPrimarybooleanrequiredWhether payouts in this currency go here.
Example true
statusstringrequiredExample Active
verificationStatusstringThe result of the last verification against the bank, where one has run.
Example Active
capabilityTagsarray of MchtCapabilityTagThe capability tags set on this merchant, which gate what some operations will do. Present on the by-id read only, because a page does not load them.
DirectDebitPayToCheckoutV2LaddrToolsFinanceAllPayPlanVariantsServiceProviderFinanceAmexDisallowedPerformNoCommsEftposDisallowedAllowLegacyDelegateCreation+3 moreShow fewer
ManualVerification, AllowPayoutRemitterUpdate, Unknown
createdAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
updatedAtstring (date-time)requiredExample 2026-08-19T04:21:07Z
A supplier: a merchant that receives money and never sells.
merchantIdMchtIdrequiredIdentifier of a merchant.
Example mcht_9f2Kd8QpLzXw
organisationIdOrgIdrequiredThe organisation this merchant is, its legal record, read at GET /organisations/{organisationId}.
Example org_9f2Kd8QpLzXw
referenceMerchantIdstringThe caller's own identifier for this merchant, if one was supplied.
Example your-own-reference
slugstringrequiredURL-safe identifier used in back-office links.
statusMchtStatusrequiredOnboardingOnboardingReviewActiveCheckoutDisabledSuspendedClosedUnknownThe outcome of verifying the business. Absent unless the principal may read merchant state.
typeenumrequiredMchtVerificationAttributesstatusMchtVerificationStatusrequiredPendingVerifiedUnknownerrorCodesarray of stringWhy verification has not completed, as platform onboarding error codes.
detailsarray of stringHuman-readable detail behind the error codes.
The trading identity of a merchant.
typeenumrequiredMchtBusinessAttributeslegalNamestringrequiredRegistered legal name of the business.
Example Ada Lovelace
brandNamestringName the business trades under, where it differs from the legal name. Taken on MchtCmdCreateSupplier; on MchtCmdCreate the platform's create has nowhere to put it, so set it afterwards with MchtUpdateBusinessProfile.
Example Ada Lovelace
businessRegistrationNumberstringABN in Australia, NZBN in New Zealand. Checked against country.
taxRegistrationNumberstringABN in Australia, IRD number in New Zealand. Checked against country, and given only with businessRegistrationNumber; in Australia it must be that same ABN. Read back as the business registration number in Australia when none was given.
countrystringrequiredExample AU
websitestringTaken on MchtCmdCreateSupplier; on MchtCmdCreate the platform's create has nowhere to put it, so set it afterwards with MchtUpdateBusinessProfile.
contactEmailstringrequiredExample ada@example.com
timeZonestringrequiredWho to contact at the business.
typeenumrequiredMchtContactAttributesfirstNamestringExample Ada Lovelace
lastNamestringExample Ada Lovelace
titlestringcontactEmailstringExample ada@example.com
supportEmailstringExample ada@example.com
phoneNumberstringE.164 format, e.g. +61400000000.
Example +61400000000
A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one.
typeenumrequiredMchtAddressAttributesunitNumberstringUnit, shop or level, as written on the building. Free text, 12, Shop 4, Level 3. Omit where there is none.
streetNumberstringrequiredStreet number, including any range or letter, 34, 34A, 34-36.
streetNamestringrequiredStreet name, without the type, Smith, not Smith Street.
Example Ada Lovelace
streetTypestringStreet, Road, Avenue. Optional because not every address has one.
suburbstringSuburb. This is where Australia and South Africa keep what other countries call the city.
citystringCity. Required in New Zealand. In Australia and South Africa send suburb instead, the platform moves whichever you send to where that country keeps it.
statestringState, province or territory. Required in Australia.
postalCodestringrequiredExample 3000
countrystringrequiredISO 3166-1 alpha-2.
Example AU
When and how the merchant is paid out.
typeenumrequiredMchtPayoutSettingsAttributesscheduleMchtPayoutScheduleDailyWeeklyFortnightlyMonthlyUnknowndayOfWeekstringRequired when schedule is Weekly.
dayOfMonthinteger (int32)Required when schedule is Monthly.
Example 6
delayDaysinteger (int32)Business days to hold funds beyond the schedule before paying out: one to four.
Example 1250
statementDescriptorstringDefault reference on the payout, where the bank shows one.
Example ADA COFFEE
payoutsEnabledbooleanTurn payouts off without changing the schedule.
Example true
automatedPayoutsEnabledbooleanRead-only. Whether the platform raises payouts on the schedule, or the merchant asks for each one.
Example true
automatedDisbursementsEnabledbooleanRead-only. Whether the platform sends the money, or someone pays it out of band and records it afterwards. This is what decides whether PayoutUpdateRecordManualPayment is accepted.
Example true
notificationEmailsarray of stringExample ada@example.com
remitterNamestringThe party named as the remitter on outgoing payments, where it differs from the merchant.
Example Ada Lovelace
How the merchant is billed for platform fees.
typeenumrequiredMchtBillingSettingsAttributesnotificationEmailsarray of stringExample ada@example.com
notificationsEnabledbooleanExample true
A postal address. Supplying one on a patch replaces the whole address, you cannot patch half of one.
typeenumrequiredMchtAddressAttributesunitNumberstringUnit, shop or level, as written on the building. Free text, 12, Shop 4, Level 3. Omit where there is none.
streetNumberstringrequiredStreet number, including any range or letter, 34, 34A, 34-36.
streetNamestringrequiredStreet name, without the type, Smith, not Smith Street.
Example Ada Lovelace
streetTypestringStreet, Road, Avenue. Optional because not every address has one.
suburbstringSuburb. This is where Australia and South Africa keep what other countries call the city.
citystringCity. Required in New Zealand. In Australia and South Africa send suburb instead, the platform moves whichever you send to where that country keeps it.
statestringState, province or territory. Required in Australia.
postalCodestringrequiredExample 3000
countrystringrequiredISO 3166-1 alpha-2.
Example AU
paymentSourceIdstringThe payment source platform fees are charged to.
Example psrc_9f2Kd8QpLzXw
Risk, settlement and verification policy for a merchant.
typeenumrequiredMchtRiskSettingsAttributessettlementTypeMchtSettlementTypeNet rolls platform fees into each payout; Gross invoices them separately.
NetGrossUnknownbankAccountVerificationRequiredbooleanWhether a bank account must be verified before it can be used.
Example true
Which verification outcomes are accepted, and whether the outcome is returned to the caller.
typeenumrequiredMchtVerificationPolicyAttributesacceptarray of MchtVerificationOutcomeOutcomes that let the account be used. Anything else is refused. Failed and Unknown cannot be accepted and are ignored if sent: what happens when the bank cannot answer is the platform's decision, not a merchant's.
MatchPartialMatchNoMatchAccountClosedFailedUnknownincludeResultInResponsebooleanReturn the verification outcome to the caller. Off by default, because it is the bank's assessment of a person.
Example true
sourceVerificationEnabledbooleanAsk a payer to confirm a small debit before their source is used, 3DS's belt and braces.
Example true
supportedCustomerTypesarray of MchtCustomerTypeWhich kinds of customer this merchant sells to.
ConsumerOrganisationUnknownThe band of payment sizes the checkout will accept.
typeenumrequiredMchtPaymentLimitsAttributescurrencyIsoCurrencyrequiredAFNDZDARSAMDAWGAUDAZNBSDBHDTHB+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
minimumPaymentAmountMinorUnitsSmallest payment the checkout will accept.
Example 1250
maximumPaymentAmountMinorUnitsLargest payment the checkout will accept.
Example 1250
disputesWaivedbooleanDo not charge this merchant for disputes.
Example true
payoutPriorityinteger (int32)Higher values are paid out ahead of lower ones.
Example 10
showPlatformLogoInTermsbooleanShow the platform's logo on the terms page shown to payers.
Example true
showSavedPaymentMethodsInCheckoutbooleanOffer the payer their saved payment sources in the checkout.
Example true
showReferenceOrderIdToCustomerbooleanShow the merchant's own order reference on communications to the payer.
Example true
emailPaymentReceiptbooleanEmail the payer a receipt when an order is paid.
Example true
emailPaymentFailurebooleanEmail the payer after a failed attempt.
Example true
Bank accounts the supplier is paid into. The reason this merchant exists. Each carries its own verification outcome.
typeenumrequiredMchtBankAccountAttributesexternalAccountIdstringrequiredExample xacc_9f2Kd8QpLzXw
accountNamestringrequiredExample Ada Lovelace
last4stringrequiredLast four digits of the account number.
Example 4242
currencystringrequiredExample AUD
isPrimarybooleanrequiredWhether payouts in this currency go here.
Example true
statusstringrequiredExample Active
verificationStatusstringThe result of the last verification against the bank, where one has run.
Example Active
capabilityTagsarray of MchtCapabilityTagThe capability tags set on this merchant, which gate what some operations will do. Present on the by-id read only, because a page does not load them.
DirectDebitPayToCheckoutV2LaddrToolsFinanceAllPayPlanVariantsServiceProviderFinanceAmexDisallowedPerformNoCommsEftposDisallowedAllowLegacyDelegateCreation+3 moreShow fewer
ManualVerification, AllowPayoutRemitterUpdate, Unknown
createdAtstring (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": "MchtPageAttributes",
"data": [
{
"type": "MchtViewStandard",
"merchantId": "mcht_9f2Kd8QpLzXw",
"organisationId": "org_9f2Kd8QpLzXw",
"referenceMerchantId": "your-own-reference",
"slug": "string",
"status": "Onboarding",
"verification": {
"type": "MchtVerificationAttributes",
"status": "Pending",
"errorCodes": [
"string"
],
"details": [
"string"
]
},
"business": {
"type": "MchtBusinessAttributes",
"legalName": "Ada Lovelace",
"brandName": "Ada Lovelace",
"businessRegistrationNumber": "string",
"taxRegistrationNumber": "string",
"country": "AU",
"website": "string",
"contactEmail": "ada@example.com"
},
"timeZone": "string",
"publicProfile": {
"type": "MchtPublicProfileAttributes",
"brandName": "Ada Lovelace",
"cardStatementName": "Ada Lovelace",
"smsSenderName": "Ada Lovelace",
"website": "string",
"supportSite": "string"
},
"contact": {
"type": "MchtContactAttributes",
"firstName": "Ada Lovelace",
"lastName": "Ada Lovelace",
"title": "string",
"contactEmail": "ada@example.com",
"supportEmail": "ada@example.com",
"phoneNumber": "+61400000000",
"address": {
"type": "MchtAddressAttributes",
"unitNumber": "string",
"streetNumber": "string",
"streetName": "Ada Lovelace",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": "3000",
"country": "AU"
}
},
"payoutSettings": {
"type": "MchtPayoutSettingsAttributes",
"schedule": "Daily",
"dayOfWeek": "string",
"dayOfMonth": 6,
"delayDays": 1250,
"statementDescriptor": "ADA COFFEE",
"payoutsEnabled": true,
"automatedPayoutsEnabled": true,
"automatedDisbursementsEnabled": true,
"notificationEmails": [
"ada@example.com"
],
"remitterName": "Ada Lovelace"
},
"billingSettings": {
"type": "MchtBillingSettingsAttributes",
"notificationEmails": [
"ada@example.com"
],
"notificationsEnabled": true,
"address": {
"type": "MchtAddressAttributes",
"unitNumber": "string",
"streetNumber": "string",
"streetName": "Ada Lovelace",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": "3000",
"country": "AU"
},
"paymentSourceId": "psrc_9f2Kd8QpLzXw"
},
"branding": {
"type": "MchtBrandingAttributes",
"logoFileId": "lfile_9f2Kd8QpLzXw",
"iconFileId": "lfile_9f2Kd8QpLzXw",
"logoAltText": "string",
"brandColour": "string"
},
"orderSettings": {
"type": "MchtOrderSettingsAttributes",
"customFields": [
{
"type": "MchtOrderCustomFieldAttributes",
"key": "string",
"label": "string",
"required": true,
"visibleToPayer": true
}
],
"notificationEmails": [
"ada@example.com"
],
"notifyOnPaid": true
},
"sourceRules": [
{
"type": "MchtRuleAttributes",
"criterion": {
"type": "MchtRuleAlways"
},
"actions": [
{
"type": "MchtRuleAllow"
}
]
}
],
"usageRules": {
"type": "MchtUsageRulesAttributes",
"currencies": {
"type": "MchtCurrencyAllow",
"currencies": [
"AUD"
]
},
"issuerCountries": {
"type": "MchtIssuerCountryAllow",
"countries": [
"AU"
]
}
},
"riskSettings": {
"type": "MchtRiskSettingsAttributes",
"settlementType": "Net",
"bankAccountVerificationRequired": true,
"bankAccountVerification": {
"type": "MchtVerificationPolicyAttributes",
"accept": [
"Match"
],
"includeResultInResponse": true
},
"sourceVerificationEnabled": true,
"supportedCustomerTypes": [
"Consumer"
],
"paymentLimits": {
"type": "MchtPaymentLimitsAttributes",
"currency": "AUD",
"minimumPaymentAmount": 1250,
"maximumPaymentAmount": 1250
},
"disputesWaived": true,
"payoutPriority": 10,
"showPlatformLogoInTerms": true,
"showSavedPaymentMethodsInCheckout": true,
"showReferenceOrderIdToCustomer": true,
"emailPaymentReceipt": true,
"emailPaymentFailure": true
},
"bankAccounts": [
{
"type": "MchtBankAccountAttributes",
"externalAccountId": "xacc_9f2Kd8QpLzXw",
"accountName": "Ada Lovelace",
"last4": "4242",
"currency": "AUD",
"isPrimary": true,
"status": "Active",
"verificationStatus": "Active"
}
],
"capabilityTags": [
"DirectDebit"
],
"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"
}