跳转到主要内容
POST

授权

x-auth-token
string
header
必填

UQPAY 提供的登录 API Token。

请求头

x-client-id
string
必填

UQPAY 生成的 API 客户端 ID

x-on-behalf-of
string<uuid>

要操作的已授权关联子账户。省略或传空值时使用凭证账户。同一码的所有操作应使用相同目标账户。不要将凭证账户 ID 显式作为子账户传入。

x-idempotency-key
string
必填

每次新建使用新的键。响应不明确时,以相同键重试相同请求。同一键用于不同请求参数会返回冲突。此请求头只能发送一次。

请求体

application/json
payment_methods
enum<string>[]
必填

选择目标账户已启用的支付方式,通过可用选项接口检查账户与渠道配置。 付款通知的 data.payment_method.type 表示本次交易实际使用的单一支付方式,不回传此数组。

Required array length: 1 - 4 elements
可用选项:
ALIPAY,
WECHAT,
PAYNOW,
UNIONPAY
currency
string
必填

使用可用选项接口返回的大写币种。 付款通知的 data.currency 表示单笔交易的币种。

amount_mode
enum<string>
必填

FIXED 使用指定金额;DYNAMIC 由付款人输入金额。

可用选项:
FIXED,
DYNAMIC
amount
string

FIXED 时必填:以主货币单位表示的正数十进制字符串,必须恰好保留两位小数。DYNAMIC 时必须完全省略,不接受 null、空字符串或零。 对账时读取付款通知中的单笔交易金额 data.amount,不要使用 DYNAMIC 静态码的 null 金额。

Pattern: ^[0-9]+\.[0-9]{2}$
store_name
string

最多 25 字节。省略或传空字符串时使用目标账户名称,不接受 null。

code_no
string

自定义码牌号。省略或传空字符串时自动生成。按字符串处理以保留前导零。仅使用 ASCII 字母和数字。options 和 requests 为保留值。不接受 null。 静态码付款通知通过 data.payment_method.<method>.static_qrcode_number_plate 关联此码;同一码可用于多笔付款。见 付款通知字段映射。

Maximum string length: 10
Pattern: ^[A-Za-z0-9]{0,10}$
extension
string

你的关联信息,省略时默认为空字符串。不会编码到二维码支付参数中。不接受 null。 静态码付款通知中的对应字段为 data.payment_method.<method>.static_qrcode_extension;它不是 data.metadata 或商户订单号。见 付款通知字段映射。

Maximum string length: 512

响应

请求已处理,资源状态需单独判断。

code_no
string
必填

码牌号,保留大小写和前导零。 静态码付款通知通过 data.payment_method.<method>.static_qrcode_number_plate 关联此码;同一码可用于多笔付款。见 付款通知字段映射。

status
string
必填

码的创建状态,不是付款状态。INITIATED 表示已开始创建,SUCCEEDED 表示码已创建。

payment_methods
enum<string>[]
必填

此码关联的支付方式。 付款通知的 data.payment_method.type 表示本次交易实际使用的单一支付方式,不回传此数组。

可用选项:
ALIPAY,
WECHAT,
PAYNOW,
UNIONPAY
currency
string
必填

此码收款使用的币种。 付款通知的 data.currency 表示单笔交易的币种。

amount_mode
enum<string>
必填

FIXED 使用指定金额;DYNAMIC 由付款人输入金额。

可用选项:
FIXED,
DYNAMIC
amount
string | null
必填

以主货币单位表示的固定付款金额;DYNAMIC 模式下为 null。响应的小数位数可能与创建请求不同。 对账时读取付款通知中的单笔交易金额 data.amount,不要使用 DYNAMIC 静态码的 null 金额。

store_name
string
必填

此码关联的门店名称。

city
string
必填

此码关联的城市。

extension
string
必填

你的关联信息,不会编码到二维码支付参数中。 静态码付款通知中的对应字段为 data.payment_method.<method>.static_qrcode_extension;它不是 data.metadata 或商户订单号。见 付款通知字段映射。

create_time
string<date-time>
必填

带时区偏移的创建时间。