Boarding an Account

In our hierarchy, one Account can have many Merchants, and each Merchant can have many Terminals. You can think of the mapping roughly as follows:

Account = Your merchant's main corporate entity
Merchant = A particular branch
Terminal = A point-of-sale within a particular branch

To create a new merchant account, you will need to send a request to the Onboarding API.

Below is a sample request containing the bare minimum required to create a new account. Complete details of the API, and the response object, are available at the Accounts documentation.

POST /accounts
{
  "business_entity": {
    "name": "Bob's Builders",
    "address": {
      "line1": "4665 Kerry Way",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country_code": "USA"
    }
  },
  "admin_user": {
    "first_name": "Bob",
    "last_name": "Example",
    "email": "[email protected]",
    "phone": "555 123 4568",
  },
  "terminal": {
    "time_zone": "EST",
    "processor_details": {
      "first_data": {
        "mid": "ABCD123456",
        "division_id": "999666555",
        "card_brands": [
          {
            "brand": "visa",
            "mcc": "1234"
          },
          {
            "brand": "mastercard",
            "mcc": "1234"
          }
        ]
      }
    }
  }
}

This will result in an Account being created for your merchant, plus a single Merchant entity, containing a single Terminal. It will also enable support for whichever card brands are specified in the request, in this example Visa and Mastercard.

A Merchant Admin user will also be created. Your merchant will be able to log-in to the Exact Gateway Admin UI as this user and administer their account.

The response from the API will contain some key pieces of information which you will need to provide to your merchant to allow them to complete their signup process and start using the Exact Admin Gateway.

The important pieces of information are:

  • the activation_url from the admin_user element
  • the MID which you submitted in the request
  • the username from the admin_user element
  • the gateway_id from the terminal element

Your merchant will need to visit the activation_url in their browser to complete their signup process (choose a password, choose security questions etc.) They will be asked for their MID when they visit that link.

For future logins to the Gateway Admin UI, they will need the username plus the password they created themselves.

To use the Payments API or Tokens API, the Merchant Admin will need to create an API Key. Details on how to do so are available in our API Access Set-up guide.