v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Terminal Management

Register Terminal

post/v2/terminal/register

Headers

x-client-idstring required

The API client id generated by UQPAY

x-idempotency-keystring uuid

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-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Request body

firm_code'01' | '02' | '03' | '04' | '05' required

Terminal manufacturer code.

01: Shengben
02: Newland
03: Xinguodu
04: imin
05: pax

firm_snstring required

Terminal serial number

terminal_modelstring required

Terminal model

Example request

{
  "firm_code": "01",
  "firm_sn": "SN123456789",
  "terminal_model": "PAX A920"
}

Response

Terminal registered successfully

create_timestring

Creation time

firm_snstring

Terminal serial number provided in request

terminal_idstring

Unique terminal identifier assigned by UQPAY

Example response

{
  "create_time": "2025-12-05 10:38:53",
  "firm_sn": "TG676SX1764902333",
  "terminal_id": "10000254"
}