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

Type

string

Minimum Length

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

Type

string

Minimum Length

Example

111222333444555

Request Schema

federalTaxId required

Type

string

Range

9 to 9 characters

corporate required

Type

object

dba required

Type

object

businessPhone required

Type

string

Pattern

^\d{10}$

Range

10 to 10 characters

Example

1234567890

businessFax

Type

string

Pattern

^\d{10}$

Range

10 to 10 characters

Example

9876543210

businessEmail required

Type

string

Pattern

^[A-Za-z0-9][A-Za-z0-9._%+-]{0,63}@(?:[A-Za-z0-9-]{1,63}\.)+[A-Za-z]{2,63}$

Range

3 to 255 characters

Example

email@example.com

businessType required

Type

string

Range

1 to 1 characters

Enum

ACGILMPST

Example

isNonProfitOrganization required

Type

boolean

Example

false

yearsInBusiness

Type

number

Range

0 to 500

Example

monthsInBusiness

Type

number

Range

0 to 11

Example

numberOfLocations required

Type

number

Range

1 to 1000000

Example

comments

Type

string

Range

1 to 255 characters

Example

DBA (Doing Business As) related comments for merchant account.

securityPassword required

Type

string

Range

1 to 50 characters

Example

r@nd0MP@s$W0rd

websites

Type

array

percentageOfBusinessTransactions required

Type

object

highTicketAmount required

Type

number

Range

1 to 99999999.99

Example

5000

averageTicketAmount required

Type

number

Range

1 to 99999999.99

Example

150.75

averageMonthlyVolume required

Type

number

Range

1 to 99999999.99

Example

60000

averageAnnualSalesVolume required

Type

number

Range

1 to 99999999.99

Example

720000

amexMonthlyVolume required

Type

number

Range

1 to 8000000

Example

3000

averageCheckAmount required

Type

number

Range

0 to 99999999.99

Example

1000

monthlyCheckVolume required

Type

number

Range

0 to 99999999.99

Example

15000

discountFrequency required

Type

string

Enum

dailymonthly

Example

daily

dynamicDescriptorId required

Type

number

Enum

012

Example

hasCheckGuarantee required

Type

boolean

Example

false

hasCheckConversion required

Type

boolean

Example

false

highTicketOverrideStatus required

Type

string

Enum

automanual

Example

manual

highTicketOverridePercentage

Type

number

Range

0 to 100

Example

retailDescriptor required

Type

string

Range

1 to 255

Example

Jo Jackson Spaceage Stereo - Audio components and services

billingDescriptorPhone

Type

string

Pattern

^[0-9]{10}$

Example

8876543210

mcc required

Type

string

Pattern

^\d{4}$

Range

4 to 4 characters

windowDiscountId required

Type

number

Example

epxItemizedBillingId required

Type

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.

Get Masked Business Data

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

Get masked merchant related business information. The following fields are masked for security:

federalTaxId: shows only the last 4 digits (e.g., *****5678)
securityPassword: Full masked (e.g., ****).

Parameters

merchantId required

Type

string

Minimum Length

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.