Registering Your Device
Registering Your Lane device
You have two options for registering your device: Manual Registration through the NMI Merchant Portal or API Registration using the Customer Present Cloud API.
Manual Registration
- Log in to your Merchant Portal: Access your NMI account online.
- Navigate to Registered Devices: Find this section under the license manager.
- Enter the registration details:
- Device Nickname: Choose a name to easily identify your device.
- Rotating Code: Enter the code displayed on your Lane device screen.
- Complete registration: Your device will now be registered and ready to perform EMV transactions in the virtual terminal.
API Registration
Registration
Before you can use a Customer-Present Cloud POI Device, you must register it to your gateway account using an API key. Doing this will return a device GUID that you can use to process payments using the POI Device. Endpointhttps://secure.networkmerchants.com/api/v2/devices/register
Headers
Every API request must be authenticated using HTTP Bearer Authentication header and include a Content-Type header.
Authorization: Bearer {MERCHANT_API_KEY}
Content-Type: application/json
Device Registration
In this request, if the registration code is valid, the device will be registered and a POI device GUID will be returned.
| Parameter | Type | Required | Description |
|---|---|---|---|
| registrationCode | string | yes | The value that appears on an internet-connected device when it is not yet registered or has been deregistered. |
| deviceNickname | string | no | When sent will appear on the POI Device screen and in the UI License Manager, as well as in Estate Management queries. |
Example Request
curl --request POST \
\--header "Authorization: Bearer {MERCHANT_API_KEY} " \
\--header "Content-Type: application/json" \
-d '{"registrationCode":"8AVJWV","deviceNickname":"My POI Device"}' \
"https://secure.networkmerchants.com/api/v2/devices/register"
Example Response
\{
"poiDevice": {
"poiDeviceId":"414b0420-b31c-4c76-9fc3-8a4f1a6dcffc",
"deviceNickname":"My POI Device",
"deviceLicense":"414b0420-b31c-4c76-9fc3-8a4f1a6dcffc",
"serialNumber":"3375191PT103344",
"registrationStatus":"registered"
}
}
Response Details
poiDeviceId
The POI device id that was returned in the register response.
deviceNickname
The device nickname provided in the request.
deviceLicense
The device license. In most cases this will be the same as poiDeviceId
serialNumber
The serial number of the device. This will never change and is a good tracking system for devices.
registrationStatus
The registration status of the device. This will always be "registered" for a registration response.
API Deregistration
When you no longer wish to use your POI Device, or need to use it with a different gateway account, you must deregister it.
In this request, if the POI device ID is valid, the deregistration will be successful and the POI device will be returned to an unregistered state.DELETE /api/v2/devices/deregister/:poiDeviceId
| Parameter | Type | Required | Description |
|---|---|---|---|
| poiDeviceId | string | yes | The device id returned back as poiDeviceId in the register response. |
Example Request
curl --request DELETE \\
\--header "Authorization: Bearer {MERCHANT_API_KEY}" \
"[https://secure.networkmerchants.com/api/v2/devices/deregister/d352da6e-8772-4433-92f6-a77c4926fd80](https://secure.networkmerchants.com/api/v2/devices/deregister/d352da6e-8772-4433-92f6-a77c4926fd80)"
Example Response
{
"registrationStatus":"deregistered"
}
Update Device Nickname
This will allow for the Device Nickname to be updated without deregistration.POST /api/v2/devices/update/:poiDeviceId
Parameter | Type | Required | Description |
|---|---|---|---|
deviceNickname | string | yes | This will appear on the POI Device screen and in the UI License Manager, as well as in Estate Management queries. This value can be empty. Value must match expression: ^[A-Za-z0-9-_ ]20$ |
Example Request
curl --request POST \
\--header "Authorization: Bearer {MERCHANT_API_KEY} " \
\--header "Content-Type: application/json" \
-d '{"deviceNickname":"My new name"}' \
"https://secure.networkmerchants.com/api/v2/devices/update/414b0420-b31c-4c76-9fc3-8a4f1a6dcffc"
Example Response
{
"success": true,
}Updated 27 days ago
