Skip to main content
UQPAY Node.js SDK 以带类型的方式访问 UQPAY API,内置自动鉴权、分页、重试与 webhook 校验。

npm

@uqpay/sdk
SDK需要Node.js 22或更高版本。1.2.0是它首次加入协调客户端版本线的发布版本。

安装

快速上手

开始前,请先创建沙盒账户创建API密钥

配置

创建 client 时传入配置项:

鉴权

SDK使用你的clientIdapiKey获取UQPAY Access Token,缓存后在当前Token到期前重新获取新Token。你无需手动管理Token。

代表子账户发起请求

代 Connected 子账户调用 API 时,传入 x-on-behalf-of 头:

幂等性

每次请求会自动生成一个 UUID 幂等键。如果要自定义:

分页

所有 list 方法返回 PaginatedResponse<T>,包含 datatotal_pagestotal_items
递增 page_number 直到 total_pages,即可遍历全部结果。

日志

开启 debug 日志可以看到所有请求和响应:
敏感字段(apiKeycard_numbercvciban 等)会自动脱敏。也可以自行追加需脱敏的字段:

调用未封装接口

对于 SDK 暂未覆盖的接口,使用通用的 request 方法:

平台信息

如果你在 UQPAY 之上构建平台,把应用信息附加到 User-Agent 头:
Stablecoin Account(Ramp)不在当前SDK产品范围内。