Merchant Management

Register a merchant in the system before registering terminals under it.

A merchant must exist before you can register terminals against it.

Register merchant — POST /api/merchants

Registers a new merchant in the system.

Request parameters

ParameterTypeRequiredDescription
merchantIdstringYesUnique identifier for the merchant
merchantNamestringYesDisplay name of the merchant
merchantSecretstringYesSecret key for merchant authentication
enabledbooleanYesWhether the merchant is active
rolestringYesMerchant role (e.g. MERCHANT)

Request

{
  "merchantId": "merchant1",
  "merchantSecret": "pos123",
  "merchantName": "Merchant One",
  "enabled": "true",
  "role": "MERCHANT"
}

Response

{
  "merchantId": "merchant1",
  "merchantName": "Merchant One",
  "enabled": true,
  "role": "MERCHANT",
  "createdAt": null
}