Merchant Management API Specification

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:

1

Example:

111222333444555

Loading...

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:

1

Example:

111222333444555

Loading...

Request Schema

firstName required

string

Example:

Dave

Loading...

lastName required

string

Example:

Joe

Loading...

title

string

Enum:

ceo

manager

owner

partner

president

vice president

Example:

owner

Loading...

dateOfBirth required

string

Example:

2006-02-02

Loading...

socialSecurityNumber required

string

Example:

123456789

Loading...

driverLicenseNumber

string

Example:

D1234556789

Loading...

driverLicenseIssuedState

string

Enum:

AK

AL

AR

AZ

CA

CO

CT

DC

DE

FL

GA

GU

HI

IA

ID

IL

IN

KS

KY

LA

MA

MD

ME

MI

MN

MO

MP

MS

MT

NC

ND

NE

NH

NJ

NM

NV

NY

OH

OK

OR

PA

PR

RI

SC

SD

TN

TX

UT

VA

VI

VT

WA

WI

WV

WY

null

Example:

TX

Loading...

isPersonalGuarantor required

boolean

Example:

true

Loading...

isPrimaryContact required

boolean

Example:

true

Loading...

equityOwnershipPercentage required

number

Example:

76

Loading...

contactType required

string

Enum:

business contact

owner

Example:

owner

Loading...

accountHolderPriority required

number

Example:

1

Loading...

email

array

Loading...

phone

array

Loading...

address

array

Loading...

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.

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:

1

Example:

111222333444555

Loading...

contactId required

string

Minimum:

1

Example:

111222333

Loading...

Example Response

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:

1

Example:

111222333444555

Loading...

contactId required

string

Minimum:

1

Example:

111222333

Loading...

Request Schema

firstName required

string

Example:

Dave

Loading...

lastName required

string

Example:

Joe

Loading...

title

string

Enum:

ceo

manager

owner

partner

president

vice president

Example:

owner

Loading...

dateOfBirth required

string

Example:

2006-02-02

Loading...

socialSecurityNumber required

string

Example:

123456789

Loading...

driverLicenseNumber

string

Example:

D1234556789

Loading...

driverLicenseIssuedState

string

Enum:

AK

AL

AR

AZ

CA

CO

CT

DC

DE

FL

GA

GU

HI

IA

ID

IL

IN

KS

KY

LA

MA

MD

ME

MI

MN

MO

MP

MS

MT

NC

ND

NE

NH

NJ

NM

NV

NY

OH

OK

OR

PA

PR

RI

SC

SD

TN

TX

UT

VA

VI

VT

WA

WI

WV

WY

null

Example:

TX

Loading...

isPersonalGuarantor required

boolean

Example:

true

Loading...

isPrimaryContact required

boolean

Example:

true

Loading...

equityOwnershipPercentage required

number

Example:

76

Loading...

contactType required

string

Enum:

business contact

owner

Example:

owner

Loading...

accountHolderPriority required

number

Example:

1

Loading...

email

array

Loading...

phone

array

Loading...

address

array

Loading...

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.

500 Internal Server Error - Error response.