Skip to main content
GET
Retrieve static QR code details

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-on-behalf-of
string<uuid>

The authorized connected sub-account to manage. Omit or send an empty value to use the credential account. Use the same target account for all operations on a code. Do not send the credential account ID as an explicit sub-account.

Path Parameters

code_no
string
required

Case-sensitive code identifier. Preserve leading zeros. Historical code numbers can be longer than the limit for creating a new code.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$

Response

Request completed. Interpret the resource status separately.

code_no
string
required

Code identifier. Preserve case and leading zeros. Static QR payment notifications identify this code in data.payment_method.<method>.static_qrcode_number_plate; one code can be used for multiple payments. See payment notification field mapping.

status
string
required

Code creation status, not payment status. INITIATED means creation has started; SUCCEEDED means the code has been created.

payment_methods
enum<string>[]
required

Payment methods associated with this code. In payment notifications, data.payment_method.type identifies the single method used for that transaction, not this array.

Available options:
ALIPAY,
WECHAT,
PAYNOW,
UNIONPAY
currency
string
required

Currency used for payments with this code. Payment notifications report the transaction currency in data.currency.

amount_mode
enum<string>
required

FIXED uses the specified amount; DYNAMIC lets the payer enter the amount.

Available options:
FIXED,
DYNAMIC
amount
string | null
required

Fixed payment amount in major currency units; null for DYNAMIC codes. Response decimal precision may differ from the create request. For reconciliation, read the transaction amount from data.amount in payment notifications, not the null amount of a DYNAMIC code.

store_name
string
required

Store name associated with the code.

city
string
required

City associated with the code.

extension
string
required

Your reference information. It is not encoded in the QR payment parameters. The corresponding field in static QR payment notifications is data.payment_method.<method>.static_qrcode_extension; it is not data.metadata or a merchant order ID. See payment notification field mapping.

create_time
string<date-time>
required

Creation timestamp with a timezone offset.

updated_time
string<date-time> | null
required

Last update timestamp, or null if no update time is available.

qr_payload
string
required

Raw QR payload. Encode this value unchanged with a QR rendering library; it is not an image URL. The corresponding field in static QR payment notifications is data.payment_method.<method>.static_qrcode. See payment notification field mapping.