Merchant Device Registration

Register or update a merchant’s device information. This endpoint is typically called during transaction requests to maintain device tracking and security measures for point-of-sale systems.

API Endpoint

URL: /v1/merchant-device
Method: POST

Request Body

The request must include a JSON payload with the device details:


{
  "merchantId": "string",
  "deviceId": "string",
  "deviceType": "string",
  "deviceName": "string",
  "osVersion": "string",
  "appVersion": "string",
  "location": {
    "latitude": "number",
    "longitude": "number"
  }
}

Successful Response Format

A successful response will return a JSON object with the status of the registration:


{
  "status": "string",
  "message": "string"
}

Error Response Format

See the Error Reference section for a full description of API errors. All API errors follow a consistent JSON structure:


{
  "error": {
    "type": "ERROR_TYPE",
    "message": "Human-readable error description",
    "details": ["Additional error details (optional)"]
  },
  "timestamp": 1755602195137
}

In the case of a validation error, the format will be as follows:


{
    "error": {
        "type": "VALIDATION_ERROR",
        "message": "Request validation failed",
        "details": [
            "/amount: Expected number to be greater or equal to 0"
        ]
    },
    "timestamp": 1755602195137
}

Schema

Request Schema


{
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "string"
    },
    "deviceId": {
      "type": "string"
    },
    "deviceType": {
      "type": "string"
    },
    "deviceName": {
      "type": "string"
    },
    "osVersion": {
      "type": "string"
    },
    "appVersion": {
      "type": "string"
    },
    "location": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        }
      }
    }
  },
  "required": ["merchantId", "deviceId", "deviceType", "deviceName", "osVersion", "appVersion", "location"]
}

Response Schema


{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": ["status", "message"]
}