Get marketplace country setting
/marketplaces/{marketplaceId}/country-settingscurl -X GET https://api.tst.au.apgpay.dev/marketplaces/{marketplaceId}/country-settings \
-H "Authorization: Bearer $API_KEY"Return the marketplace's profile and sub-merchant template for one tax country. Sections you may not read are absent.
Permissions
marketplaces:queryRequires the `query` action on `marketplaces` for the supplied runtime context
Path parameters
marketplaceIdstringQuery parameters
taxCountryIsoCountryISO 3166-1 alpha-2. Required, a marketplace's profile is per tax country, so there is no template to read without one.
AFAXALDZASADAOAIAQAG+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
Responses
The response is a tagged shape: type is always "MktpCountrySettingsAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "MktpCountrySettingsAttributes"taxCountryIsoCountryrequiredISO 3166-1 alpha-2.
AFAXALDZASADAOAIAQAG+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
Who to contact at the marketplace. Used on communications sent on behalf of its sub-merchants.
typeenumrequiredMktpContactAttributesfirstNamestringExample Ada Lovelace
lastNamestringExample Ada Lovelace
titlestringcontactEmailstringThe marketplace's own email address.
Example ada@example.com
supportEmailstringWhere sub-merchants' customers are told to write. Omit to use contactEmail.
Example 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
How the marketplace entity is registered in one tax country.
typeenumrequiredMktpBusinessRegistrationAttributesbusinessNamestringrequiredBusiness name, as it appears against the registration number.
Example Ada Lovelace
businessTypeMchtBusinessTyperequiredCompanyIndividualSoleTraderPartnershipTrustUnknownindustrystringrequiredIndustry classification, the MCC code's name.
businessRegistrationNumberstringrequiredThe business registration number: the ABN in Australia, the NZBN in New Zealand.
taxRegistrationNumberstringThe tax registration number, where it differs: the ABN in Australia, the IRD number in New Zealand.
Branding sub-merchants inherit on checkouts and communications.
typeenumrequiredMktpBrandingAttributesiconUristringrequiredFully qualified https URI of the icon image.
Example https://example.com/callback
logoUristringrequiredFully qualified https URI of the logo image.
Example https://example.com/callback
logoAltTextstringrequiredShown when the logo image cannot be loaded.
supportEmailstringWhere sub-merchants' customers are told to write.
Example ada@example.com
businessDisplayNamestringThe name sub-merchants' customers see, where it differs from the registered business name.
Example Ada Lovelace
businessWebsitestringcustomOrderBaseUristringBase URI for pay-by-link order URLs generated for sub-merchants.
Example https://example.com/callback
primaryColorstringHex, e.g. #0B7285. Overrides the theme's primary colour in customer-facing components.
Branding on sub-merchants' own dashboards.
typeenumrequiredMktpBrandingAttributesiconUristringrequiredFully qualified https URI of the icon image.
Example https://example.com/callback
logoUristringrequiredFully qualified https URI of the logo image.
Example https://example.com/callback
logoAltTextstringrequiredShown when the logo image cannot be loaded.
supportEmailstringWhere sub-merchants' customers are told to write.
Example ada@example.com
businessDisplayNamestringThe name sub-merchants' customers see, where it differs from the registered business name.
Example Ada Lovelace
businessWebsitestringcustomOrderBaseUristringBase URI for pay-by-link order URLs generated for sub-merchants.
Example https://example.com/callback
primaryColorstringHex, e.g. #0B7285. Overrides the theme's primary colour in customer-facing components.
Payout defaults sub-merchants inherit.
typeenumrequiredMktpPayoutDefaultsAttributespayoutDescriptionstringrequiredWhat appears on the recipient's bank statement.
scheduleMchtPayoutScheduleDailyWeeklyFortnightlyMonthlyUnknowndayOfWeekstringMonday to Friday. Read when schedule is Weekly or Fortnightly; defaults to Monday.
dayOfMonthinteger (int32)Read when schedule is Monthly; defaults to 1.
Example 6
delayDaysinteger (int32)Business days held between taking a payment and disbursing it. One to four; the platform's own default is two.
Example 1250
issueDelayDaysinteger (int32)Days between creating a payout and issuing it. Defaults to 0.
Example 1250
automatedPayoutsEnabledbooleanPay out any available balance automatically on the schedule.
Example true
automatedDisbursementsEnabledbooleanLet the system disburse the payout rather than an operator doing it by hand.
Example true
The fees new sub-merchants are created with. Copied onto each one, not inherited.
typeRates in the older shape, one table for paying in full, one for paying by plan. Superseded.
Fees by payment form. Superseded by FeeStructEx, which can price each pay-plan variant separately.
typeenumrequiredFeeStructAttributesCharged when the customer pays by plan.
typeenumrequiredFeeTableAttributesA fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
Charged when the customer pays in full.
typeenumrequiredFeeTableAttributesA fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
Rates in the current shape, with each pay-plan variant priced separately.
Fees by payment form, with each pay-plan variant priced separately.
typeenumrequiredFeeStructExAttributesOne entry per pay-plan variant and customer type offered. A variant with no entry cannot be paid by.
typeenumrequiredPayPlanFeeEntryAttributespayPlanVariantSrchqPayPlanVariantrequiredFourFortnightlyQuartersFourWeeklyEightWeeklyTwentySixFortnightlyFiftyTwoWeeklyTwoMonthlyThreeMonthlyFourMonthlyFiveMonthlySixMonthly+11 moreShow fewer
SevenMonthly, EightMonthly, NineMonthly, TenMonthly, ElevenMonthly, TwelveMonthly, FortnightDeferred, FourWeekDeferred, SevenWeekDeferred, ThirtyDayDeferred, Unknown
customerTypeSrchqCustomerTyperequiredConsumerOrganisationUnknownDomestic and international fees. Which applies is decided by the card's issuing country, not the payer's address.
typeenumrequiredFeeTableAttributesA fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
Charged when the customer pays in full by card.
typeenumrequiredFeeTableAttributesA fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
A fee: a rate on the amount plus a fixed charge, with per-card overrides where they differ.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
Charged when the customer pays by direct debit. Absent where direct debit is not offered.
typeenumrequiredFeeAttributesratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit, cents for AUD. Added to the rate's product.
Example 1250
Overrides for particular cards. The most specific match wins; anything unmatched takes rate and fixed.
typeenumrequiredCardFeeAttributescardFundingCardFundingrequiredCreditDebitChargeCardPrepaidDeferredDebitUnknowncardBrandCardBrandOmit to match every brand of that funding type.
VisaMasterCardAmericanExpressDinersClubDiscoverUnionPayMaestroEloMirHiper+5 moreShow fewer
Hipercard, Jcb, Electron, Uatp, Unknown
ratenumberrequiredA ratio of the amount, not a percentage 0.0175 is 1.75%. Zero to one.
Example 0.9412
fixedinteger (int64)requiredFixed charge in the smallest currency unit.
Example 1250
Source rules created alongside those fees.
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 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
calculateTaxOnFeebooleanWhether tax is added to the platform's fees.
Example true
feesTaxExemptbooleanWhether the sub-merchant is exempt from tax on fees.
Example true
The email templates communications are sent from on behalf of the marketplace and its sub-merchants.
typeenumrequiredMktpEmailTemplatesAttributesplatformSupportSenderNamestringrequiredName shown as the sender on platform-support communications.
Example Ada Lovelace
platformSupportEmailstringrequiredExample ada@example.com
platformSupportEmailSignedBystringName the email is signed with, where it differs from the sender.
Example ada@example.com
platformSupportReplyToNamestringExample Ada Lovelace
platformSupportReplyToEmailstringExample ada@example.com
customerSupportSenderNamestringName shown as the sender on communications to sub-merchants' customers. Omit to use the platform-support name.
Example Ada Lovelace
customerSupportEmailstringExample ada@example.com
customerSupportEmailSignedBystringExample ada@example.com
customerSupportReplyToNamestringExample Ada Lovelace
customerSupportReplyToEmailstringExample ada@example.com
customerEmailBrandLogostringFully qualified https URI of the logo shown in emails to customers.
Example ada@example.com
merchantOnboardingRequestedTemplateIdstringrequiredTemplate sent when a sub-merchant is asked to onboard.
merchantOnboardingCompletedTemplateIdstringrequiredTemplate sent when a sub-merchant finishes onboarding.
merchantResetPasswordTemplateIdstringrequiredmerchantResetPasswordConfirmationTemplateIdstringrequiredmerchantNewOrganisationCustomerDelegateTemplateIdstringTemplate sent to a new delegate of an organisation customer. Absent where the marketplace has no organisation customers.
merchantNewOrganisationCustomerDelegateConfirmationTemplateIdstringpaymentProfileMktpPaymentProfileThe payment provider new sub-merchants are created on.
StripeConnectAUStripeConnectAUAbacusStripeConnectNZAbacusAbacusCheckoutAbacusCheckoutStripeCompositeAbacusCardlessAbacusWorldpayAuAbacusWorldpayNzAbacusWorldpayStripeCompositeAuAbacusWorldpayStripeCompositeNz+11 moreShow fewer
AbacusFiserv, AbacusFiservStripeComposite, AbacusFiservNz, AbacusFiservNzStripeComposite, AbacusReslyNzStripeConnect, AbacusOnUsAu, AbacusOnUsNz, AbacusOnUsHk, AbacusOnUsSg, AbacusMock, Unknown
createdAtstring (date-time)Example 2026-08-19T04:21:07Z
updatedAtstring (date-time)Example 2026-08-19T04:21:07Z
{
"type": "MktpCountrySettingsAttributes",
"taxCountry": "AU",
"contact": {
"type": "MktpContactAttributes",
"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"
}
},
"businessRegistration": {
"type": "MktpBusinessRegistrationAttributes",
"businessName": "Ada Lovelace",
"businessType": "Company",
"industry": "string",
"businessRegistrationNumber": "string",
"taxRegistrationNumber": "string"
},
"branding": {
"type": "MktpBrandingAttributes",
"iconUri": "https://example.com/callback",
"logoUri": "https://example.com/callback",
"logoAltText": "string",
"supportEmail": "ada@example.com",
"businessDisplayName": "Ada Lovelace",
"businessWebsite": "string",
"customOrderBaseUri": "https://example.com/callback",
"primaryColor": "string"
},
"customerDashboardBranding": {
"type": "MktpBrandingAttributes",
"iconUri": "https://example.com/callback",
"logoUri": "https://example.com/callback",
"logoAltText": "string",
"supportEmail": "ada@example.com",
"businessDisplayName": "Ada Lovelace",
"businessWebsite": "string",
"customOrderBaseUri": "https://example.com/callback",
"primaryColor": "string"
},
"payoutDefaults": {
"type": "MktpPayoutDefaultsAttributes",
"payoutDescription": "string",
"schedule": "Daily",
"dayOfWeek": "string",
"dayOfMonth": 6,
"delayDays": 1250,
"issueDelayDays": 1250,
"automatedPayoutsEnabled": true,
"automatedDisbursementsEnabled": true
},
"subMerchantFees": {
"type": "FeesByPaymentForm",
"fees": {
"type": "FeeStructAttributes",
"split": {
"type": "FeeTableAttributes",
"domestic": {
"type": "FeeAttributes",
"rate": 0.9412,
"fixed": 1250,
"cards": [
{
"type": "CardFeeAttributes",
"cardFunding": "Credit",
"cardBrand": "Visa",
"rate": 0.9412,
"fixed": 1250
}
]
},
"international": {
"type": "FeeAttributes",
"rate": 0.9412,
"fixed": 1250,
"cards": [
{
"type": "CardFeeAttributes",
"cardFunding": "Credit",
"cardBrand": "Visa",
"rate": 0.9412,
"fixed": 1250
}
]
}
},
"full": {
"type": "FeeTableAttributes",
"domestic": {
"type": "FeeAttributes",
"rate": 0.9412,
"fixed": 1250,
"cards": [
{
"type": "CardFeeAttributes",
"cardFunding": "Credit",
"cardBrand": "Visa",
"rate": 0.9412,
"fixed": 1250
}
]
},
"international": {
"type": "FeeAttributes",
"rate": 0.9412,
"fixed": 1250,
"cards": [
{
"type": "CardFeeAttributes",
"cardFunding": "Credit",
"cardBrand": "Visa",
"rate": 0.9412,
"fixed": 1250
}
]
}
}
}
},
"sourceRules": [
{
"type": "MchtRuleAttributes",
"criterion": {
"type": "MchtRuleAlways"
},
"actions": [
{
"type": "MchtRuleAllow"
}
]
}
],
"calculateTaxOnFee": true,
"feesTaxExempt": true,
"emailTemplates": {
"type": "MktpEmailTemplatesAttributes",
"platformSupportSenderName": "Ada Lovelace",
"platformSupportEmail": "ada@example.com",
"platformSupportEmailSignedBy": "ada@example.com",
"platformSupportReplyToName": "Ada Lovelace",
"platformSupportReplyToEmail": "ada@example.com",
"customerSupportSenderName": "Ada Lovelace",
"customerSupportEmail": "ada@example.com",
"customerSupportEmailSignedBy": "ada@example.com",
"customerSupportReplyToName": "Ada Lovelace",
"customerSupportReplyToEmail": "ada@example.com",
"customerEmailBrandLogo": "ada@example.com",
"merchantOnboardingRequestedTemplateId": "string",
"merchantOnboardingCompletedTemplateId": "string",
"merchantResetPasswordTemplateId": "string",
"merchantResetPasswordConfirmationTemplateId": "string",
"merchantNewOrganisationCustomerDelegateTemplateId": "string",
"merchantNewOrganisationCustomerDelegateConfirmationTemplateId": "string"
},
"paymentProfile": "StripeConnectAU",
"createdAt": "2026-08-19T04:21:07Z",
"updatedAt": "2026-08-19T04:21:07Z"
}Error responses
statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}