Businesses

🚧

In development

A legacy version of the Merchant Boarding API is live currently, however a new enhanced version is in development. For new consumers, it is highly recommended to use the new version of the API expected in Q3 2022.

Please note the API specification may change while it's in development

Businesses Resource

A business can be used to organise a merchant into different segments (e.g. geographical locations) and to form a layered hierarchy. A business doesn't have a transacting MID (merchant ID) so never has any terminals associated directly to it.

Mandatory Fields

AttributeTypeDescriptionExample / ENUMS
mccstringThe Merchant Category Code for the customer's overall business.5462 - Full list of MCC codes.
merchantLanguagestringThe primary language of the customerEN (see options in table below)
legalNamestringThe legal/registered name of the customer's businessJohn Smith Shoe Shop Ltd
registrationCountrystringThe legal/registered country of the customer's businessGBR ISO 3166 alpha-3 country code.
tradeNamestringThe legal/registered trading name of the customer's businessJohn Smith Shoe Shop
storesarrayThe storeEntityId of any stores which sit under this business entity in the merchant hierarchy42fe86b0-5a6f-438b-8c1f-b1cb26cdb5ab
contactsarrayThe contactId of any contacts for the business entity497f6eca-6276-4993-bfeb-53cbbbba6f08
bankAccountIdstringThe ID of the bank account497f6eca-6276-4993-bfeb-53cbbbba6f08
accountTypestringDefines the type of bank account that the information is being sent/stored for (e.g. Payment Account retail, Merchant Hold account, etc.)Payment Account Retail

Conditional Fields

AttributeTypeDescriptionExample / ENUMS
accountTypeSysIdstringSystem ID used to identify the bank account type for Fiserv clients using the OmniPay acquiring platform196

Optional Fields

AttributeTypeDescriptionExample / ENUMS
externalmerchantidstringTo be used when a merchant ID (MID) is allocated by the Alliance/Partner to the non trading business entity and the Fiserv MID allocation service is not used in such case667712300000001
childBusinessEntitiesarrayTo be used to input the businessEntityId when creating a layered hierarchy42fe86b0-5a6f-438b-8c1f-b1cb26cdb5ab
dateFromdateThe date from which the bank account was activated2010-06-02
dateTodateThe date to which the bank account was deactivated2019-06-02

Examples

Example Request

{
     "bankAccounts": [
          {
               "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
               "accountType": "Payment Account Retail",
               "accountTypeSystemId": "196",
               "dateFrom": "2022-04-07",
               "dateTo": "2022-04-07"
          }
     ],
     "contacts": [
          {
               "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
     ],
     "mcc": "0742",
     "merchantLanguage": "CZECH",
     "legalName": "John Smith Shoe Shop Ltd",
     "tradeName": "John Smith Shoe Shop",
     "registrationCountry": "GBR",
     "taxId": "12345",
     "customFields": [
          {
               "customFieldCode": "Enter custom code",
               "customFieldValue": "Enter custom value"
          }
     ],
     "externalMerchantId": "520334547514337",
     "crmAccountId": "0061D000003KfikQAC",
     "crmContactId": "0061D000003KfikQAC",
     "aggregateAnnualTurnover": "64000",
     "aggregateAnnualCardTurnover": "56000",
     "stores": [
          {
               "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
     ],
     "childBusinesses": [
          {
               "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
     ]
}

Example Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "bankAccounts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "accountType": "Payment Account Retail",
      "accountTypeSystemId": "196",
      "dateFrom": "2022-04-07",
      "dateTo": "2022-04-07"
    }
  ],
  "contacts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "mcc": "0742",
  "merchantLanguage": "CZECH",
  "legalName": "John Smith Shoe Shop Ltd",
  "tradeName": "John Smith Shoe Shop",
  "registrationCountry": "GBR",
  "taxId": "12345",
  "customFields": [
    {
      "customFieldCode": "Enter custom code",
      "customFieldValue": "Enter custom value"
    }
  ],
  "externalMerchantId": "520334547514337",
  "crmAccountId": "0061D000003KfikQAC",
  "crmContactId": "0061D000003KfikQAC",
  "aggregateAnnualTurnover": "64000",
  "aggregateAnnualCardTurnover": "56000",
  "stores": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "childBusinesses": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Did this page help you?