Merchant Management API Specification

Merchant Management API

Get List of Contacts

get /merchant-management/contacts/mid/{merchantId}

Get list of all merchant contact information such as contact address, email, phone number, and fax by merchant ID. If no contacts are found for the merchant ID, an empty data array is returned.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Example Response

200 OK - Success response.

400 Bad Request - Error response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.

Add New Contact

post /merchant-management/contacts/mid/{merchantId}

Add new merchant contact with information such as contact address, email, phone number, and fax. Account holder priority must also be unique for each contact associated with the merchant ID.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Request Schema

firstName required

string1 to 65 characters

Example:

lastName required

string1 to 65 characters

Example:

title required

string

Enum:

ceo

manager

owner

partner

president

vice president

Example:

ceo

dateOfBirth required

string^\d{4}-\d{2}-\d{2}$

Example:

1999-01-01

socialSecurityNumber required

string^\d{9}$9 to 9 characters

Example:

123123123

driverLicenseNumber required

string1 to 255 characters

Example:

ABC123456789

driverLicenseIssuedState required

string2 to 2 characters

Enum:

Example:

isPersonalGuarantor required

boolean

Example:

true

isPrimaryContact required

boolean

Example:

true

equityOwnershipPercentage required

number

Example:

contactType required

string

Enum:

owner

business contact

Example:

owner

accountHolderPriority required

number

Example:

email required

array

phone required

array

address required

array

Example Request

{
  "contactId": 111222333,
  "firstName": "Roy",
  "lastName": "Martin",
  "title": "owner",
  "dateOfBirth": "1947-11-05",
  "socialSecurityNumber": "354123987",
  "driverLicenseNumber": "ABC1234567890",
  "driverLicenseIssuedState": "MI",
  "isPersonalGuarantor": true,
  "isPrimaryContact": true,
  "equityOwnershipPercentage": 76,
  "contactType": "owner",
  "accountHolderPriority": 1,
  "email": [
    {
      "emailType": "business",
      "email": "roymartin@spaceagestereo.com"
    }
  ],
  "phone": [
    {
      "phoneType": "business",
      "phoneNumber": "5805671234",
      "phoneExtension": null
    },
    {
      "phoneType": "home",
      "phoneNumber": "8876543210",
      "phoneExtension": null
    },
    {
      "phoneType": "fax",
      "phoneNumber": "8876543211",
      "phoneExtension": null
    }
  ],
  "address": [
    {
      "addressType": "home",
      "street": "828 Late Avenue",
      "street2": "",
      "city": "South Burlington",
      "state": "VT",
      "zipCode": "73601",
      "yearsAtAddress": 2,
      "monthsAtAddress": 6
    }
  ]
}

Example Response

200 OK - Success response.

400 Bad Request - Error response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

422 Unprocessable Content - Error response.

500 Internal Server Error - Error response.

Get Contact Data by Contact ID

get /merchant-management/contacts/mid/{merchantId}/contact-id/{contactId}

Get merchant contact information such as contact address, email, phone number, fax by merchant ID and contact ID. Contact ID is unique for each merchant contact.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

contactId required

number

Minimum:

Example:

123456

Example Response

200 200 OK - Success response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.

Update Contact Data by Contact ID

put /merchant-management/contacts/mid/{merchantId}/contact-id/{contactId}

Update merchant contact information such as contact address, email, phone number, fax by merchant ID and contact ID.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

contactId required

number

Minimum:

Example:

123456

Request Schema

firstName required

string1 to 65 characters

Example:

lastName required

string1 to 65 characters

Example:

title required

string

Enum:

ceo

manager

owner

partner

president

vice president

Example:

ceo

dateOfBirth required

string^\d{4}-\d{2}-\d{2}$

Example:

1999-01-01

socialSecurityNumber required

string^\d{9}$9 to 9 characters

Example:

123123123

driverLicenseNumber required

string1 to 255 characters

Example:

ABC123456789

driverLicenseIssuedState required

string2 to 2 characters

Enum:

Example:

isPersonalGuarantor required

boolean

Example:

true

isPrimaryContact required

boolean

Example:

true

equityOwnershipPercentage required

number

Example:

contactType required

string

Enum:

owner

business contact

Example:

owner

accountHolderPriority required

number

Example:

email required

array

phone required

array

address required

array

Example Request

{
  "firstName": "Roy",
  "lastName": "Martin",
  "title": "owner",
  "dateOfBirth": "1947-11-05",
  "socialSecurityNumber": "354123987",
  "driverLicenseNumber": "ABC1234567890",
  "driverLicenseIssuedState": "MI",
  "isPersonalGuarantor": true,
  "isPrimaryContact": true,
  "equityOwnershipPercentage": 76,
  "contactType": "owner",
  "accountHolderPriority": 1,
  "email": [
    {
      "emailType": "business",
      "email": "roymartin@spaceagestereo.com"
    }
  ],
  "phone": [
    {
      "phoneType": "business",
      "phoneNumber": "5805671234",
      "phoneExtension": null
    },
    {
      "phoneType": "home",
      "phoneNumber": "8876543210",
      "phoneExtension": null
    },
    {
      "phoneType": "fax",
      "phoneNumber": "8876543211",
      "phoneExtension": null
    }
  ],
  "address": [
    {
      "addressType": "home",
      "street": "828 Late Avenue",
      "street2": "",
      "city": "South Burlington",
      "state": "VT",
      "zipCode": "73601",
      "yearsAtAddress": 2,
      "monthsAtAddress": 6
    }
  ]
}

Example Response

200 OK - Success response.

400 Bad Request - Error response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

422 Unprocessable Content - Error response.

500 Internal Server Error - Error response.