Merchant Management API Specification

Merchant Management API

Get Business Data

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

Get merchant business information such as DBA, corporate information, websites, and business transactions parameters.

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.

Update Business Data

patch /merchant-management/business/mid/{merchantId}

Update merchant business information such as DBA, corporate information, websites, and business transactions parameters. Partial updates are supported. Only the fields provided in the request payload will be updated; all other fields will remain unchanged. To clear a field, set its value to null in the request payload.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Request Schema

federalTaxId required

string9 to 9 characters

corporate required

object

dba required

object

businessPhone required

string

businessFax

string

businessEmail required

string

businessType required

string1 to 1 characters

Enum:

Example:

isNonProfitOrganization required

boolean

Example:

false

yearsInBusiness

number

Example:

monthsInBusiness

number

Example:

numberOfLocations required

number

Example:

comments

string1 to 40 characters

Example:

Application submitted through MEAP

securityPassword required

string1 to 50 characters

Example:

r@nd0MP@s$W0rd

websites

array

percentageOfBusinessTransactions required

object

highTicketAmount required

number

Example:

5000

averageTicketAmount required

number

Example:

150.75

averageMonthlyVolume required

number

Example:

60000

averageAnnualSalesVolume required

number

Example:

720000

amexMonthlyVolume required

number

Example:

3000

averageCheckAmount required

number

Example:

1000

monthlyCheckVolume required

number

Example:

15000

discountFrequency required

string

Enum:

daily

monthly

Example:

daily

dynamicDescriptorId required

number

Enum:

Example:

hasCheckGuarantee required

boolean

Example:

false

hasCheckConversion required

boolean

Example:

false

highTicketOverrideStatus required

string

Enum:

auto

manual

Example:

manual

highTicketOverridePercentage

number

Example:

retailDescriptor required

string

Example:

Jo Jackson Spaceage Stereo - Audio components and services

billingDescriptorPhone

string^[0-9]{10}$

Example:

8876543210

mcc required

string4 to 4 characters

windowDiscountId required

number

Example:

epxItemizedBillingId required

number

Example:

Example Request

{
  "status": "success",
  "data": {
    "federalTaxId": "123567654",
    "corporate": {
      "name": "Joe's Spaceage Stereo",
      "street": "1447 Sun Valley Rd",
      "street2": null,
      "city": "South Burlington",
      "state": "VT",
      "zipCode": "99201"
    },
    "dba": {
      "name": "Jo Jackson Spaceage Stereo",
      "street": "1072 Clinton St",
      "street2": null,
      "city": "South Burlington",
      "state": "VT",
      "zipCode": "72211"
    },
    "businessPhone": "8876543210",
    "businessFax": "8876543211",
    "businessEmail": "joejackson@spaceagestereo.com",
    "businessType": "C",
    "isNonProfitOrganization": false,
    "yearsInBusiness": 10,
    "monthsInBusiness": 10,
    "numberOfLocations": 15,
    "comments": "Sample merchant business account related comments.",
    "securityPassword": "1111",
    "websites": [
      {
        "url": "https://spaceagestereos.biz",
        "dynamicDescriptor": "Jo Jackson Spaceage Stereo",
        "customerServiceEmail": "customer-service-email@example.com",
        "customerServicePhone": "1234567890"
      }
    ],
    "percentageOfBusinessTransactions": {
      "cardSwiped": 15,
      "cardKeyed": 20,
      "mailOrPhoneOrder": 50,
      "internet": 15
    },
    "highTicketAmount": 10000,
    "averageTicketAmount": 500,
    "averageMonthlyVolume": 25000,
    "averageAnnualSalesVolume": 300000,
    "amexMonthlyVolume": 83333.33,
    "averageCheckAmount": 0,
    "monthlyCheckVolume": 0,
    "discountFrequency": "daily",
    "dynamicDescriptorId": 0,
    "hasCheckGuarantee": false,
    "hasCheckConversion": false,
    "highTicketOverrideStatus": "auto",
    "highTicketOverridePercentage": 20,
    "retailDescriptor": "Jo Jackson Spaceage Stereo - Audio components and services",
    "billingDescriptorPhone": "8876543210",
    "epxItemizedBillingId": 1,
    "mcc": "5812"
  },
  "link": "/merchant-management/business/mid/111222333444555"
}

Example Response

200 OK - Success response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.