API Reference

POST/merchants

Body Parameters

namestring

Required. The merchant's legal/business name.

mccstring

Required. Merchant category code (ISO 18245, 4 digits). No default — omitting or blanking it returns 422 validation_error.

trading_namestring(optional)

Optional at create (defaults to name). May be required to board some acquirers.

company_numberstring(optional)

The merchant's company/business registration number (e.g. an Australian Business Number). Optional at create. May be required to board some acquirers.

websitestring(optional)

Optional.

emailstring (email)(optional)

Optional.

phonestring(optional)

Optional.

addressany(optional)

Business address. Optional at create. May be required to board some acquirers.

statement_descriptorstring(optional)

Optional. Card-acceptor name. Defaults to the trading/business name, truncated to 25 chars.

government_controlledboolean(optional)

Optional. Whether the merchant is government-controlled. Defaults to false.

country_of_originstring(optional)

Optional. ISO-3166 alpha-2 country of origin.

country_codestring(optional)

Optional. ISO-3166 numeric country code.

fee_program_indicatorstring(optional)

Optional. Scheme fee program indicator.

mastercard_iso_idstring(optional)

Optional. Mastercard ISO/acquirer identifier.

visa_iso_idstring(optional)

Optional. Visa ISO/acquirer identifier.

mastercard_assigned_idstring(optional)

Optional. Mastercard Assigned ID (MAID).

visa_merchant_verification_valuestring(optional)

Optional. Visa Merchant Verification Value (MVV).

customer_support_phonestring(optional)

Optional. Customer support phone number shown to cardholders.

card_acceptor_namestring(optional)

Optional. Card-acceptor name sent to the card schemes. Defaults to the statement descriptor / trading name when omitted.

card_acceptor_locationstring(optional)

Optional. Card-acceptor location (city) sent to the card schemes.

card_acceptor_countrystring(optional)

Optional. Card-acceptor country, ISO-3166 alpha-2.

usernamestring(optional)

Optional. When omitted, one is derived from the trading/business name. Either way the stored username is prefixed with the partner's reseller prefix. Immutable post-creation.

acquirersarray of objects(optional)

Optional. When present, boards the merchant onto each acquirer and activates it (combined create). All-or-nothing: if any acquirer can't be boarded the whole create rolls back. See the response MerchantOnboardingResult.

acquirers[0].acquirerstring

Acquirer code (e.g. bnz). Must be available to the partner.

acquirers[0].merchant_idstring

Acquirer-assigned MID. Required.

acquirers[0].terminal_idstring(optional)

Acquirer-assigned TID. Optional.

acquirers[0].currenciesarray of strings(optional)

Optional. Defaults to everything the acquirer supports.