创建收款订单

用于创建一笔固定金额的共享收款订单,系统会返回订单号、收款地址、收银台地址和支付状态。

notifyUrl 为必填字段,平台后续会按订单维度把回调直接投递到这个地址。

POST/openapi/payin/orders

请求头

字段名称字段类型是否必填说明
x-api-keystring是商户 API Key,使用商户后台 API 接入页面中的 mch_ 开头字符串。
x-merchant-uidstring是商户 UID。
x-timestampstring是13 位毫秒时间戳,默认允许和服务器时间相差 5 分钟。
x-noncestring是每次请求唯一的随机字符串,最长 128 位,重复使用会被拒绝。
x-signaturestring是使用 HMAC-SHA256 生成的十六进制签名,签名原文由 Merchant UID、时间戳、nonce、请求方法、路径、规范化 query 和规范化 body 组成。

接口参数

字段名称字段类型是否必填说明
chainCodestring是链编码,支持 TRON / BSC / SOL。
tokenSymbolstring是代币符号,例如 USDT。
merchantOrderNostring是商户订单号。 最长 128 个字符。
amountstring是收款金额,最多保留 6 位小数。
notifyUrlstring是该订单专用的回调通知地址,建议传商户自己的公网 HTTPS 地址。 最长 500 个字符;禁止私网、回环和不安全目标。

请求示例

{
  "chainCode": "TRON",
  "tokenSymbol": "USDT",
  "merchantOrderNo": "M202604150001",
  "amount": "100.00",
  "notifyUrl": "https://merchant.example.com/api/uugate/payin-notify"
}

接口返回

字段名称字段类型是否必填说明
orderNostring是平台订单号。
merchantOrderNostring | null是商户订单号。
bindKeystring | null是独享钱包场景的绑定键;共享收款订单为空。
chainCodestring | null是订单所属网络。
tokenSymbolstring | null是订单所属币种。
txHashstring | null是匹配的交易哈希,未检测到时为空。
amountstring | null是订单金额。
paidAmountstring | null是实收金额,未支付时为空。
addressstring | null是实际收款地址。
cashierUrlstring | null是含随机访问令牌的收银台完整地址,完整保留 #ct= 片段。
paymentUristring | null是钱包拉起 URI。
expireAtstring | null是订单失效时间。
createdAtstring | null是创建时间。
detectedAtstring | null是检测到付款时间,未检测到时为空。
confirmedAtstring | null是链上确认时间,未确认时为空。
completedAtstring | null是订单完成时间,未完成时为空。
statusstring是订单状态。

返回示例

{
  "orderNo": "PI1776193200123ABCD1234",
  "merchantOrderNo": "M202604150001",
  "bindKey": null,
  "amount": "100.000000",
  "paidAmount": null,
  "address": "TXYZ3x9nJ5J4xP2gh6mQW7rT31jB8Y2pA9",
  "cashierUrl": "https://open.uugate.com/SK/PI1776193200123ABCD1234#ct=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "paymentUri": "TRON:TXYZ3x9nJ5J4xP2gh6mQW7rT31jB8Y2pA9?token=USDT&amount=100.000000",
  "expireAt": "2026-04-18T06:30:00.000Z",
  "createdAt": "2026-04-18T06:00:00.000Z",
  "detectedAt": null,
  "confirmedAt": null,
  "completedAt": null,
  "status": "waiting_payment",
  "chainCode": "TRON",
  "tokenSymbol": "USDT",
  "txHash": null
}

代码示例

运行:Java 保存为 UUGateExample.java(回调为 UUGateCallback.java),使用 java 文件名;PHP 保存为 example.php,使用 php example.php;Go 保存为 example.go,使用 go run example.go;Node.js 保存为 example.mjs,使用 node example.mjs。回调原文从标准输入读取。

import { createHmac, randomBytes } from 'node:crypto';

function required(name) {
  const value = process.env[name]?.trim();
  if (!value) throw new Error(name + ' is required');
  return value;
}
const uid = required("UUGATE_MERCHANT_UID"), key = required("UUGATE_API_KEY");
const timestamp = String(Date.now()), nonce = randomBytes(16).toString("hex");
const method = 'POST', path = '/openapi/payin/orders';
const canonicalQuery = '', canonicalBody = "{\"amount\":\"100.00\",\"chainCode\":\"TRON\",\"merchantOrderNo\":\"M202604150001\",\"notifyUrl\":\"https://merchant.example.com/api/uugate/payin-notify\",\"tokenSymbol\":\"USDT\"}";
const payload = [uid, timestamp, nonce, method, path, canonicalQuery, canonicalBody].join('\n');
const signature = createHmac('sha256', key).update(payload, 'utf8').digest('hex');
const base = (process.env.UUGATE_BASE_URL || 'https://api.uugate.com').replace(/\/+$/, '');
const response = await fetch(base + path, {
  method, redirect: 'error', signal: AbortSignal.timeout(30000),
  headers: { 'Content-Type': 'application/json', 'x-api-key': key, 'x-merchant-uid': uid,
    'x-timestamp': timestamp, 'x-nonce': nonce, 'x-signature': signature },
  ...(canonicalBody ? { body: canonicalBody } : {}),
});
const raw = await response.text();
if (!response.ok) throw new Error('HTTP ' + response.status + ': ' + (raw || 'empty response body'));
JSON.parse(raw);
console.log(raw);

说明

  • 共享收款订单在同一商户、同一链、同一币种、同一金额且仍在有效期内时,可能触发 40105 金额占用错误。
  • 四种语言使用相同的接口路径、参数和返回合同。示例从环境变量 UUGATE_MERCHANT_UID、UUGATE_API_KEY 读取凭据;UUGATE_BASE_URL 默认 https://api.uugate.com。
  • 示例中的 canonicalBody 已按字段名排序并压缩为 JSON;修改参数后须递归排序对象字段,数组顺序保持,使用 UTF-8 且不额外转义斜杠或 Unicode。金额使用字符串,boolean 使用 true / false。
  • 成功响应直接返回业务对象,没有统一的 code / data 外层。先判断 HTTP 状态,再处理正文;普通业务错误返回 code、message、data、requestId,安全拒绝可能只有 HTTP 401 / 403 和空正文。
  • 网络超时或 HTTP 5xx 后先查询订单,不自动重复创建或提交付款;每次新请求重新生成 timestamp、nonce 和签名。