🚧

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

Contacts Resource

Contacts are used in Businesses and Stores. The address used for contacts is always in relation to a business or oulet address, it's never the personal address of the contact.

Mandatory Fields

AttributeTypeDescriptionExample
firstNamestringThe first name of the contactJohn
lastNamestringThe surname of the contactSmith
jobTitlestringThe job title/positon in the business of the contactStore Owner
phoneNumberobjectThe main telephone number for the contact, countryCode and subscriber{"countryCode": "44", "subscriber": "7724914829"}
streetLine1stringThe first line of the street address for the contactSomething Street
citystringThe city of the address for the contact Sheffield
zipCodestringThe zip/postal code of the address for the contactTW2 7LD
countrystringThe country code of the address for the contactGBR ISO 3166 alpha-3 country code.
contactTypestringThe type of contact. See table below for further details on enumsLEGAL

Conditional Fields

AttributeTypeDescriptionExample / ENUMS
emailstringThe email address of the contact[email protected] (mandatory where 'contactType' = INITIAL_IPP_PORTAL_USER)
houseNamestringThe house name of the address for the contact. Either houseName or houseNumber must be sentHouse
houseNumberstringThe house number of the address for the contact. Either houseName or houseNumber must be sent10

Optional Fields

AttributeTypeDescriptionExample / ENUMS
middleNamestringThe second/middle name of the contactAdam
TitlestringThe title/salutation of the contactMr
streetLine2stringThe second line of the street address for the contactSomething Street
streetLine3stringThe third line of the street address for the contactSomething Street

Contact Types

EnumerationDescriptionLink to resource
LEGALA contact for legal (usually the registered office/HQ)Business
TRADING_STOREA contact for an storeStore
ALTERNATIVE_TRADING_STOREAn alternative contact for an storeStore
BILLINGA contact for billingStore
SHIPPINGA contact for shippingStore
INITIAL_IPP_PORTAL_USERA contact who will use Merchant PortalBusiness or Store

Examples

Example Request

{
     "title": "Mr",
     "firstName": "John",
     "middleName": "Adam",
     "lastName": "Smith",
     "email": "[email protected]",
     "contactType": "LEGAL",
     "jobTitle": "CEO",
     "address": {
          "buildingNumber": "10",
          "buildingName": "House",
          "line1": "Something Street",
          "line2": "Something Street",
          "line3": "Something Street",
          "city": "Sheffield",
          "postalCode": "TW2 7LD",
          "country": "GBR"
     },
     "phoneNumber": {
          "countryCode": "44",
          "subscriber": "7724914829"
     }
}

Example Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "title": "Mr",
  "firstName": "John",
  "middleName": "Adam",
  "lastName": "Smith",
  "email": "[email protected]",
  "contactType": "LEGAL",
  "jobTitle": "CEO",
  "address": {
    "buildingNumber": "10",
    "buildingName": "House",
    "line1": "Something Street",
    "line2": "Something Street",
    "line3": "Something Street",
    "city": "Sheffield",
    "postalCode": "TW2 7LD",
    "country": "GBR"
  },
  "phoneNumber": {
    "countryCode": "44",
    "subscriber": "7724914829"
  }
}

Did this page help you?