DEVELOPER
DEVELOPER

Merchant Management API Specification

account-managementreporting

Version 1.11.3

production
sandbox

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
Type
string
Minimum Length
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
Type
string
Minimum Length
1
Example
111222333444555

Loading...

Request Schema
firstName required
Type
string
Range
1 to 65 characters
Example

Loading...

lastName required
Type
string
Range
1 to 65 characters
Example

Loading...

title required
Type
string
Enum
ceomanagerownerpartnerpresidentvice president
Example
ceo

Loading...

dateOfBirth required
Type
string
Pattern
^\d{4}-\d{2}-\d{2}$
Example
1999-01-01

Loading...

socialSecurityNumber required
Type
string
Pattern
^\d{9}$
Range
9 to 9 characters
Example
123123123

Loading...

driverLicenseNumber required
Type
string
Range
1 to 255 characters
Example
ABC123456789

Loading...

driverLicenseIssuedState required
Type
string
Range
2 to 2 characters
Enum
AKALARAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUTVAVIVTWAWIWVWY
Example
MI

Loading...

isPersonalGuarantor required
Type
boolean
Example
true

Loading...

isPrimaryContact required
Type
boolean
Example
true

Loading...

equityOwnershipPercentage required
Type
number
Range
0 to 100
Example
45

Loading...

contactType required
Type
string
Enum
ownerbusiness contact
Example
owner

Loading...

accountHolderPriority required
Type
number
Range
1 to 10
Example
5

Loading...

email required
Type
array

Loading...

phone required
Type
array

Loading...

address required
Type
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.
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
Type
string
Minimum Length
1
Example
111222333444555

Loading...

contactId required
Type
number
Minimum Length
1
Example
123456

Loading...

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
Type
string
Minimum Length
1
Example
111222333444555

Loading...

contactId required
Type
number
Minimum Length
1
Example
123456

Loading...

Request Schema
firstName required
Type
string
Range
1 to 65 characters
Example

Loading...

lastName required
Type
string
Range
1 to 65 characters
Example

Loading...

title required
Type
string
Enum
ceomanagerownerpartnerpresidentvice president
Example
ceo

Loading...

dateOfBirth required
Type
string
Pattern
^\d{4}-\d{2}-\d{2}$
Example
1999-01-01

Loading...

socialSecurityNumber required
Type
string
Pattern
^\d{9}$
Range
9 to 9 characters
Example
123123123

Loading...

driverLicenseNumber required
Type
string
Range
1 to 255 characters
Example
ABC123456789

Loading...

driverLicenseIssuedState required
Type
string
Range
2 to 2 characters
Enum
AKALARAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUTVAVIVTWAWIWVWY
Example
MI

Loading...

isPersonalGuarantor required
Type
boolean
Example
true

Loading...

isPrimaryContact required
Type
boolean
Example
true

Loading...

equityOwnershipPercentage required
Type
number
Range
0 to 100
Example
45

Loading...

contactType required
Type
string
Enum
ownerbusiness contact
Example
owner

Loading...

accountHolderPriority required
Type
number
Range
1 to 10
Example
5

Loading...

email required
Type
array

Loading...

phone required
Type
array

Loading...

address required
Type
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.
422 Unprocessable Content - Error response.
500 Internal Server Error - Error response.
Get Started
Working With UsHardwareSecurityFAQsGlossaryTags by Topic
Products
In-Person PaymentsOnline PaymentsFull-FeaturedMerchant Management
Explore
About UsBlogNorth.comNorth HubNorth Exchange
More
Log InCreate AccountContact UsTerms of UsePrivacy PolicyCookies
©2026 North is a registered DBA of NorthAB, LLC. All rights reserved. North is a registered ISO of BMO Harris Bank N.A., Chicago, IL, Citizens Bank N.A., Providence, RI, The Bancorp Bank, Philadelphia, PA, FFB Bank, Fresno, CA, Wells Fargo Bank, N.A., Concord, CA, and PNC Bank, N.A.