---
title: "Register"
source_url: https://docs.rapyd.net/en/register.html
lang: en
---

# Register

Register the serial number of a PAX device and a callback URL for the webhook which will be called when the PAX device pair's against Cloudlink.The registration will be active for one hour. If that time passes without the pairing process in the terminal being activated, the terminal must be re-registered.

### Parameters

### Request Header Parameters

- - X-API-KEY
  - Unique access key provided by Rapyd for each partner.

### Request Body Parameters

- - serialNumber
  - The PAX device serial number. Minimum length: 10 characters
- - pairingCallback
  - The callback url for Cloudlink to call when the PAX device pair's against Cloudlink. Minimum length: 1 character.

### 202 Accepted Response

- - message
  - Accepted

### 401 Error Response

- - message
  - Unauthorized

### 500 Error Response

- - message
  - Server Error

- /register

- 202 Register Terminal Successfully
- ```curl
  curl -X
  post https://CloudLinkApi/register
  -H 'X-API-KEY: your-access-key-here'
  {
  	"serialNumber": "0822170138",
  	"pairingCallback": "http://example.com/webhook-endpoint"
  } 
  ```
- ```json
  {
   "message": "Accepted"	
  }
  ```

- 401 Register Terminal - Unauthorized
- ```curl
  curl -X
  post https://CloudLinkApi/register
  -H 'X-API-KEY: your-access-key-here'
  -d '
  {
  	"serialNumber": "0822170138",
  	"pairingCallback": "http://example.com/webhook-endpoint"
  } 
  '
  ```
- ```json
  {
    "message": "Unauthorized"
  }
  ```

- 500 Register Terminal - Server Error
- ```curl
  curl -X
  post https://CloudLinkApi/register
  -H 'X-API-KEY: your-access-key-here'
  -d '
  {
  	"serialNumber": "0822170138",
  	"pairingCallback": "http://example.com/webhook-endpoint"
  } 
  '
  ```
- ```json
  {
    "message": "Server Error"
  }
  ```