Skip to main content

Documentation

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
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
401 Error Response

    • message

    • Unauthorized

500 Error Response

    • message

    • Server Error

  • /register

  • 202 Register Terminal Successfully

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

  • 401 Register Terminal - Unauthorized

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

  • 500 Register Terminal - Server Error

  • curl -X
post https://CloudLinkApi/register
-H 'X-API-KEY: your-access-key-here'
-d '
{
	"serialNumber": "0822170138",
	"pairingCallback": "http://example.com/webhook-endpoint"
} 
'
  • {
  "message": "Server Error"
}
In this section: