Merchant Management API Specification

Merchant Management API

Get Pricing Profile

get /merchant-management/pricing/profile/mid/{merchantId}

Get merchant pricing profile information by merchant ID (MID). This endpoint retrieves the pricing profile details associated with the specified merchant ID, including fee structures, discount rates, and other relevant pricing information.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Example Response

200 Successfully retrieved pricing profile information

400 Bad request - Invalid merchant ID format

401 Unauthorized - Invalid or missing authentication token

403 Forbidden - Merchant ID not affiliated with client token

404 Not found - Pricing profile not found for merchant

500 Internal server error

Update Pricing Profile

patch /merchant-management/pricing/profile/mid/{merchantId}

Update merchant pricing profile information by merchant ID (MID). Only the fields provided in the request body will be updated; all other fields will remain unchanged. Partial updates are supported. At least one field must be provided in the request body to perform an update. If no fields are provided, a 400 Bad Request error will be returned.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Request Schema

billAllAuthorizations

boolean

Enum:

Example:

true

hasDebitInterchangeBilling

boolean

Enum:

Example:

false

hasDetailedInterchange

boolean

Enum:

Example:

true

hasPreDurbinBilling

boolean

Enum:

Example:

false

isAchBillingEnabled

boolean

Enum:

Example:

true

isAchProcessingEnabled

boolean

Enum:

Example:

true

isCreditCardBillingEnabled

boolean

Enum:

Example:

false

isCreditCardProcessingEnabled

boolean

Enum:

Example:

true

retainReturnInterchangeOption

string

Enum:

Example:

returnBillingOption

number

Enum:

Example:

Example Request

{
  "billAllAuthorizations": false,
  "hasDebitInterchangeBilling": true,
  "hasDetailedInterchange": true,
  "hasPreDurbinBilling": false,
  "isAchBillingEnabled": false,
  "isAchProcessingEnabled": false,
  "isCreditCardBillingEnabled": true,
  "isCreditCardProcessingEnabled": true,
  "retainReturnInterchangeOption": "B",
  "returnBillingOption": 1
}

Example Response

200 Successfully updated pricing profile information

400 Bad request - Invalid request data

401 Unauthorized - Invalid or missing authentication token

403 Forbidden - Merchant ID not affiliated with client token

404 Not found - Pricing profile not found for merchant

500 Internal server error

Get Fee Data

get /merchant-management/pricing/fees/mid/{merchantId}

Get merchant fees by merchant ID (MID). Returns a list of fees associated with the merchant. If no fees are found, an empty list is returned.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Example Response

200 Successfully retrieved merchant pricing fees

401 Unauthorized API Response

403 Forbidden error response

500 Internal server error

Add New Fee

post /merchant-management/pricing/fees/mid/{merchantId}

Add new fees to merchant pricing profile by merchant ID (MID). Existing fees will not be updated. To update existing fees, use the PUT endpoint. Multiple fees can be added in a single request. The request body should contain an array of fee objects with details such as fee ID, fee status, effective date, retail discount rate, and retail per item. The response will confirm the successful creation of the fees along with their details.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Request Schema

items

object

Example Request

{
  "feeId": 10001,
  "feeStatus": 1,
  "effectiveDate": "2023-05-23",
  "retailDiscountRate": 0.456,
  "retailPerItem": 0.567
}

Example Response

200 Successfully created merchant pricing fees

400 Bad request error response

401 Unauthorized API Response

403 Forbidden error response

500 Internal server error

Update Fees

put /merchant-management/pricing/fees/mid/{merchantId}

Update merchant pricing related fees by merchant ID (MID). Fees are matched by fee ID. Only existing fees can be updated; new fees cannot be added using this endpoint.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Request Schema

items

object

Example Request

{
  "feeId": 10001,
  "feeStatus": 1,
  "effectiveDate": "2023-05-23",
  "retailDiscountRate": 0.456,
  "retailPerItem": 0.567
}

Example Response

200 Successfully updated merchant pricing fees

400 Bad request error response

401 Unauthorized API Response

403 Forbidden error response

500 Internal server error