Skip to main content
POST
Pair Mobile Companion Device

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pairing_code
string
required

The 6-digit numeric pairing code displayed on the merchant settings dashboard.

Example:

"482931"

device_id
string
required

Hardware identifier unique to the companion device.

Example:

"358291039201921"

device_name
string
default:Unknown
Example:

"Samsung SM-G991B"

app_version
string
default:1.0.0
Example:

"v1.2.4"

platform
enum<string>
default:android
Available options:
android,
ios
Example:

"android"

Response

Device paired and registered successfully.

success
boolean
Example:

true

data
object
Last modified on July 12, 2026