跳转到主要内容
Stablecoin Account API 发布方声明 本页介绍适用于所有 Stablecoin Account 接口的术语与请求约定。建议在开始集成前通读一遍 —— 指南的其余部分默认你已掌握这些概念。

资产、网络与余额

以下四个术语贯穿整个 API: 每个余额分为三个部分:
  • available_balance —— 当前可以提现、兑换或转账的资金。
  • frozen_balance —— 被在途订单或风控审核锁定的资金。
  • margin_balance —— 作为保证金预留的资金。
通过 List Assets 查询余额;在向用户开放某个资产-网络组合之前,务必先查询 List Supported Assets and Networks:它会告诉你充值和提现当前是否开放、最小金额、精度以及预计到账时间。

钱包地址

钱包地址和余额不是一回事:余额是你持有的资金,钱包地址是付款方向你转入加密货币的目标位置。UQPAY 按资产-网络组合生成并管理地址 —— 首次请求时创建,之后每次请求都返回同一个地址,可以放心重复调用。每个地址只接受其对应网络上的对应资产;以其他代币形式、或经其他网络发送的资金无法自动入账。 通过 Deposit Wallet Address 获取地址(完整流程见接收充值),或在商户后台直接查看 —— 参见钱包地址 - 在商户后台查看钱包地址

订单类型与生命周期

每一次资金变动都会创建一个订单,包含长 order_id(UUID)和便于人工识别的 short_order_id(例如 WD260124-N1PAAIXX)。订单会出现在统一的资产交易流水中,类型为以下之一:

订单状态

充值和提现只使用其中的 PendingSuccess / Failed 子集。只把 Success 和终态的 failed webhook 事件当作最终状态;受网络拥堵影响,Pending 订单可能持续较长时间。

请求约定

Base URL

所有 Stablecoin Account 接口都位于 /v1/ramp/ 路径下,两个环境的路径完全相同。

认证

使用 x-client-idx-api-key 凭证从 Access Token 接口获取访问令牌,然后在每次调用时携带:

代表子账户操作

传入可选的 x-on-behalf-of 请求头(值为子账户的 account_id),即可代表该子账户执行请求;不传则以主账户身份操作。子账户机制参见 Connected Accounts

幂等性

会创建订单的写接口 —— Create TransferCreate ConversionCreate WithdrawCreate Address BookUpdate Address BookSubmit Deposit Sender Travel Rule —— 都接受 x-idempotency-key 请求头(UUID)。使用相同的 key 重试请求会返回原始结果,而不会创建重复订单。每个业务操作生成一个新的 UUID,网络重试时复用同一个:

响应结构

所有响应都使用同一套结构封装。code 与 HTTP 状态码一致,data 承载结果:
列表接口在 data 内通过 total_pagestotal_items 分页,由 page_numpage_size 查询参数控制。金额字段是十进制字符串(例如 "100.50")—— 请用十进制类型解析,不要用浮点数。非 2xx 响应参见错误码

Webhooks

订单状态变化会以 ramp.<resource>.<status> 命名的事件(例如 ramp.deposit.success)推送到你配置的 webhook 端点。每个事件的 data 携带订单内容,source_id 携带订单 ID。各事件的报文参见 Webhooks 标签页