Device - MineSec Developer Docs

Terminal List

Retrieves a list of terminal devices associated with a merchant.

GET /api/v2/device
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
deviceId	query	string	true	Merchant ID

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	OK	Wrapper: `Response List<T>` Data: Device

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "total": 10,
    "current": 1,
    "hasNext": false,
    "records": [
      {
        "deviceType": "COTS",
        "appVersion": "1.2.3",
        "deviceAdmin": "admin",
        "extParams": {
          "subMid": "000",
          "clientId": "000",
          "jwtSecret": "000",
          "acqMid": "000",
          "subTid": "000",
          "mid": "000",
          "acqTid": "000"
        },
        "deviceId": "CD-12345678",
        "activateCodeAlias": "Terminal-01",
        "uuid": "abcd-1234-efgh-5678",
        "deviceStatus": 1,
        "activesAt": "2023-01-01T10:00:00Z",
        "createdAt": "2022-12-25T08:00:00Z",
        "emvParams": "...",
        "methodList": "...",
        "updatedAt": "2023-02-15T14:30:00Z",
        "serverUrl": "https://api.example.com",
        "customerId": "C-123456",
        "licenseId": "L-123456",
        "signKeyId": "KEY-123456",
        "cardBdkId": "BDK-123456",
        "profileId": "P-123456",
        "isDevice": true
      }
    ]
  }
}

Generate Activation Code

Creates a new activation code for a terminal device.

POST /api/v2/device
Content-Type: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
activateCodeAlias	body	string	true	A friendly name for the activation code
deviceType	body	string	true	Device type (e.g., "COTS")
mchId	body	string	true	Merchant ID
emvParams	body	object	false	EMV configuration parameters
methodList	body	string	false	Supported payment methods
extParams	body	string	false	Additional parameters

Request Body Example

{
  "emvParams": {
    "amexFloorLimit": "00000100",
    "terminalCountryCode": "0840",
    "txnCurrencyCode": "0840",
    "amexExReaderCapability": 18000,
    "amexReaderCapability": "C3",
    "terminalType": 21,
    "terminalCapability": "0068C8",
    "emvFlags": "VMAUJDP"
  },
  "activateCodeAlias": "Store-Terminal-01",
  "deviceType": "COTS",
  "methodList": "...",
  "extParams": "...",
  "mchId": "M-12345678"
}

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	OK	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "activeCode": "CD-87654321"
  }
}

Terminal Logout & Suspend

Updates the status of a terminal device (logout, decomission, etc.).

DELETE /api/v2/device/{deviceId}
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	Device ID (activation code with 'CD-' prefix)
deviceStatus	query	integer	false	0-Inactive; 1-Active; 2-Logout; 3-Decomission

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	OK	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "id": 12345
  }
}

Update Terminal

Updates an existing terminal device configuration.

PUT /api/v2/device/{deviceId}
Content-Type: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
deviceId	path	string	true	Device ID
deviceType	body	string	false	Device type
deviceAdmin	body	string	false	Admin password
activateCodeAlias	body	string	false	A friendly name for the terminal
emvParams	body	string	false	EMV configuration parameters
methodList	body	string	false	Supported payment methods
extParams	body	string	false	Additional parameters

Request Body Example

{
  "deviceType": "COTS",
  "deviceAdmin": "123456",
  "activateCodeAlias": "Store-Terminal-02",
  "emvParams": "{\"amexFloorLimit\":\"00000100\",\"terminalCountryCode\":\"0840\",\"txnCurrencyCode\":\"0840\",\"amexExReaderCapability\":\"18E00003\",\"amexReaderCapability\":\"C3\",\"terminalType\":\"21\",\"terminalCapability\":\"0068C8\",\"emvFlags\":\"VMAUJDP\"}",
  "methodList": "{\"all\":{\"tid\":\"71001007\",\"mid\":\"001007514956667\"}}",
  "extParams": "{\"all\":{\"tid\":\"71001007\",\"mid\":\"001007514956667\"}}"
}

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	OK	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "id": 12345
  }
}

Merchant Transaction