> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/payengine-api-v2.5/device-management/register-a-device.md).

# Register a device

## Register a device

<mark style="color:green;">`POST`</mark> `https://<Platform-host>/api/merchant/:merchantId/devices`

#### Path Parameters

| Name                                           | Type   | Description                  |
| ---------------------------------------------- | ------ | ---------------------------- |
| merchant\_id<mark style="color:red;">\*</mark> | string | Platform unique merchant ID |

#### Request Body

| Name                                               | Type   | Description                     |
| -------------------------------------------------- | ------ | ------------------------------- |
| name<mark style="color:red;">\*</mark>             | string | Device Nickname                 |
| activation\_code<mark style="color:red;">\*</mark> | string | Activation Code from the device |

{% tabs %}
{% tab title="200: OK " %}
{% tabs %}
{% tab title="Response fields" %}

<table><thead><tr><th width="256.6497763813563">Field Name</th><th width="150">Types</th><th>Description</th></tr></thead><tbody><tr><td>data.device_id</td><td>string</td><td>Unique device ID</td></tr><tr><td>data.device_nickname</td><td>string</td><td>Device Nickname</td></tr><tr><td>data.device_license</td><td>string</td><td>Device License</td></tr><tr><td>data.serial_number</td><td>string</td><td>Device Serial Number</td></tr><tr><td>data.registration_status</td><td>string</td><td>registered</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Sample Request" %}

```javascript
{
  "name": "Link 2500 SN60040", // required
  "activation_code": "12TY78U" // required
}
```

{% endtab %}

{% tab title="Sample Response" %}

```json
{
    "data": {
        "device_id": "e68f0b4d-6a64-4426-a7b7-062be8e4d32e",
        "device_nickname": "Link 2500 SN60040",
        "device_license": "891479098",
        "serial_number": "30912900920880040",
        "registration_status": "registered"
    }
}
```

{% endtab %}
{% endtabs %}
