> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Register device

POST https://api-sandbox.payabli.com/api/Cloud/register/{entry}
Content-Type: application/json

Register a cloud device to an entrypoint. See [Devices Quickstart](/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.

Reference: https://beta-docs.payabli.com/api-reference/cloud/register-cloud-device

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `entry` (string, required) — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)

### Headers

- `idempotencyKey` (string, optional) — A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

### Body (application/json)

This endpoint expects an object.

- `description` (string, optional) — Description or name for the device. This can be anything, but Payabli recommends entering the name of the paypoint, or some other easily-identifiable descriptor. If you have several devices for one paypoint, you can give them descriptions like "Cashier 1" and "Cashier 2", or "Front Desk" and "Back Office"
- `registrationCode` (string, optional) — The device registration code or serial number, depending on the model. - Ingenico devices: This is the activation code that's displayed on the device screen during setup. - PAX A920 device: This code is the serial number on the back of the device.

## Response

### 200

Success

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components.
- `responseData` (string, optional) — If `isSuccess` = true, this contains the device identifier. If `isSuccess` = false, this contains the reason for the error.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Examples

**Request**

```json
{
  "description": "Front Desk POS",
  "registrationCode": "YS7DS5"
}
```

**Response**

```json
{
  "isSuccess": true,
  "responseData": "6c361c7d-674c-44cc-b790-382b75d1xxx",
  "responseText": "Success"
}
```

**SDK Code**

```python Register
import requests

url = "https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267"

payload = {
    "description": "Front Desk POS",
    "registrationCode": "YS7DS5"
}
headers = {
    "requestToken": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Register
const url = 'https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267';
const options = {
  method: 'POST',
  headers: {requestToken: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"description":"Front Desk POS","registrationCode":"YS7DS5"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Register
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267"

	payload := strings.NewReader("{\n  \"description\": \"Front Desk POS\",\n  \"registrationCode\": \"YS7DS5\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("requestToken", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Register
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["requestToken"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Front Desk POS\",\n  \"registrationCode\": \"YS7DS5\"\n}"

response = http.request(request)
puts response.read_body
```

```java Register
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267")
  .header("requestToken", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Front Desk POS\",\n  \"registrationCode\": \"YS7DS5\"\n}")
  .asString();
```

```php Register
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267', [
  'body' => '{
  "description": "Front Desk POS",
  "registrationCode": "YS7DS5"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Register
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267");
var request = new RestRequest(Method.POST);
request.AddHeader("requestToken", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"description\": \"Front Desk POS\",\n  \"registrationCode\": \"YS7DS5\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Register
import Foundation

let headers = [
  "requestToken": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "description": "Front Desk POS",
  "registrationCode": "YS7DS5"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Cloud/register/8cfec329267")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```