Skip to main content
GET
List static QR codes

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.

Query Parameters

code_no
string

Exact case-sensitive match; preserve leading zeros.

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

Send a positive decimal integer once. Empty, fractional, and negative values are rejected.

Required range: x >= 1
page_size
integer

Maximum number of codes per page. Send a positive decimal integer once.

Required range: 1 <= x <= 100
currency
string

Filter by payment currency.

payment_method
string

One method, or 1–4 distinct values separated by commas: ALIPAY, WECHAT, PAYNOW, UNIONPAY. Case-sensitive, without spaces. A code matches if it includes any selected method.

create_start_time
string<date-time>

Creation time lower bound. Supply both bounds in YYYY-MM-DDTHH:mm:ss+08:00 format. Start must be earlier than end; maximum range is 30 days. URL-encode the timezone plus sign as %2B.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+08:00$
create_end_time
string<date-time>

Creation time upper bound. Supply both bounds in YYYY-MM-DDTHH:mm:ss+08:00 format. Start must be earlier than end; maximum range is 30 days. URL-encode the timezone plus sign as %2B.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+08:00$

Response

Request completed. Interpret the resource status separately.

data
object[]
required
total_items
integer
required

Total number of matching codes.

Required range: x >= 0
total_pages
integer
required

Total number of pages for the requested page size.

Required range: x >= 0