Merchant Management API Specification

Merchant Management API

Get List of Equipment

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

Get list of all merchant equipment(s) and related information by merchant ID. By default, response includes active equipment only. In order to include inactive equipment, set the optional query param includeInactiveEquipments as true.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

includeInactiveEquipments

boolean

Default:

false

Example:

false

Example Response

200 OK - Success response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.

Add New Equipment

post /merchant-management/equipment/mid/{merchantId}

Add merchant equipment and related information by merchant ID. Only iso equipment provider, terminal and pinpad equipment types, and setup order type are allowed for adding new equipment. Terminal setting parameters are required when adding terminal equipment type. Pinpad equipment type does not require terminal setting parameters.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

Request Schema

equipmentInventoryId required

integer

Example:

123456

equipmentProvider

string

Default:

iso

Enum:

iso

Example:

iso

equipmentStatus

string

Default:

active

Enum:

active

Example:

active

equipmentType required

string

Enum:

pinpad

terminal

orderType

string

Default:

setup

Enum:

setup

Example:

setup

serialNumber

string1 to 255 characters

Example:

A111B222C333D444E555

shipmentTrackingNumber

string1 to 255 characters

Example:

A111B222C333D444E555

terminalSettingsParameters required

object

Default:

null

Example Request

{
  "equipmentInventoryId": 123456,
  "equipmentProvider": "iso",
  "equipmentStatus": "active",
  "equipmentType": {
    "enum": [
      "pinpad",
      "terminal"
    ]
  },
  "orderType": "setup",
  "serialNumber": "A111B222C333D444E555",
  "shipmentTrackingNumber": "A111B222C333D444E555",
  "terminalSettingsParameters": null
}

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 Equipment Data by Equipment ID

get /merchant-management/equipment/mid/{merchantId}/equipment-record-id/{equipmentRecordId}

Get details related to specific merchant equipment based on merchant ID and equipment record ID. By default, the response includes active equipment only. In order to include inactive equipment, set the optional query param includeInactiveEquipments as true.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

equipmentRecordId required

integer

Example:

111222333

includeInactiveEquipments

boolean

Default:

false

Example:

false

Example Response

200 OK - Success response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.

Update Equipment Data by Equipment ID.

patch /merchant-management/equipment/mid/{merchantId}/equipment-record-id/{equipmentRecordId}

Update details related to specific merchant equipment based on merchant ID and equipment record ID. Only the fields provided in the request body will be updated; all other fields will remain unchanged. Partial updates are supported.

Parameters

merchantId required

string

Minimum:

Example:

111222333444555

equipmentRecordId required

integer

Example:

111222333

Request Schema

equipmentProvider

string

Enum:

iso

Example:

iso

equipmentStatus

string

Default:

active

Enum:

active

inactive

Example:

active

orderType

string

Enum:

setup

Example:

setup

serialNumber

string1 to 255 characters

Example:

A111B222C333D444E555

shipmentTrackingNumber

string1 to 255 characters

Example:

A111B222C333D444E555

terminalSettingsParameters

object

Example Request

{
  "equipmentProvider": "iso",
  "equipmentStatus": "active",
  "orderType": "setup",
  "serialNumber": "A111B222C333D444E555",
  "shipmentTrackingNumber": "A111B222C333D444E555",
  "terminalSettingsParameters": {
    "baseType": "terminal",
    "batchAutoCloseTime": "0000",
    "batchCloseType": "auto",
    "deploymentProvider": "north",
    "frontendVendor": "epx",
    "isDebitEnabled": true,
    "isEbtEnabled": true,
    "isEpxTicValidationEnabled": true,
    "platform": {
      "enum": [
        "epx"
      ]
    },
    "terminalNumber": "111222333"
  }
}

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.