Skip to main content
POST
/
v2
/
terminal
/
register
Register Terminal
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v2/terminal/register \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "firm_code": "01",
  "firm_sn": "SN123456789",
  "terminal_model": "PAX A920"
}
'
{
  "create_time": "2025-12-05 10:38:53",
  "firm_sn": "TG676SX1764902333",
  "terminal_id": "10000254"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-client-id
string
required

The API client id generated by UQPAY

​
x-idempotency-key
string<uuid>
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Body

application/json
​
firm_code
enum<string>
required

Terminal manufacturer code.

Available options:
01,
02,
03,
04,
05
Example:

"01"

​
firm_sn
string
required

Terminal serial number

Example:

"SN123456789"

​
terminal_model
string
required

Terminal model

Example:

"PAX A920"

Response

Terminal registered successfully

​
create_time
string

Creation time

Example:

"2025-12-05 10:38:53"

​
firm_sn
string

Terminal serial number provided in request

Example:

"TG676SX1764902333"

​
terminal_id
string

Unique terminal identifier assigned by UQPAY

Example:

"10000254"