API 文档
Paymos 商户 REST API 文档:收款、账单、转出和 Webhook 的接口说明,含快速开始、HMAC 身份认证、错误响应格式和沙箱环境。
快速开始
API
身份认证
用 HMAC-SHA256 认证每个 Merchant API 请求:必需请求头、规范化载荷构造、时间戳与防重放保护。
API 密钥
创建 Payment 或 Payout API 密钥,了解其作用域与前缀,安全轮换凭证,并隔离测试与正式访问。
Base URL
测试与正式请求共用一个 Paymos Merchant API base URL,通过密钥前缀选择环境,保持一条集成路径。
支持的币种
在项目启用资产前,先确认 13 个区块链网络中哪些支持 USDT、USDC、USD1、DAI 和黄金锚定的 XAUT。
错误处理
一致地处理 Merchant API 错误:响应封装、HTTP 状态分组、机器可读错误码、请求限制与重试指引。
错误码
用稳定的机器可读错误码处理 Merchant API 失败,含字段级校验明细和文档化的恢复路径。
通用
账单
POST
创建账单
创建账单以接收加密货币付款。两种流程:直接加密货币(代币和网络固定)与法币(客户在托管收银台选择代币)。
GET
账单列表
按严格的状态和日期筛选条件列出账单,用游标分页向前翻页,对账不产生重复页。
POST
确认付款
从自定义收银台为法币或代币计价的账单确认代币和网络,然后展示返回的充值地址与付款信息。
GET
获取账单
按 ID 获取单个账单,查看付款与确认状态,并用你自己的外部订单号完成对账。
POST
取消账单
在客户锁定资产之前取消未完成的账单,了解允许的状态迁移,并处理取消响应。
POST
模拟账单付款
让沙箱账单走完一个付款结果,测试与真实链上转账确认相同的生命周期和 webhook。
转出
POST
创建转出
从代币余额向白名单钱包创建转出,选择付款网络,签名请求,并跟踪其状态。
GET
转出列表
按严格筛选条件列出转出,用游标分页向前翻页,核对目标网络,可靠地对账转账历史。
GET
获取转出
按 ID 获取一笔转出,查看其当前状态和交易引用,并配合签名 webhook 完成对账。
POST
取消转出
在交易签名开始前取消待处理的转出,了解哪些状态允许取消,并处理更新后的响应。
POST
模拟转出完成
不广播交易即可完成待处理的沙箱转出,端到端验证付款 webhook。
余额
收款通道
POST
创建收款通道
为单个付款人创建可重复使用的收款身份,以你自己的外部标识为键,每条支持的网络配一个永久地址。
GET
收款通道列表
以最新在前的顺序用游标翻阅你的收款通道,并按项目、状态或你自己的外部标识筛选。
GET
获取收款通道
读取单个收款通道:每条网络的永久地址、该网络此刻接受的代币,以及你现行的费率。
POST
停用收款通道
停止把新的充值计入某个收款通道,同时不删除记录、不释放地址、不影响已经收到的付款。
POST
恢复收款通道
让收款通道重新接收充值;服务端按它是否已有地址,把它置回 active 或 provisioning。
GET
轮询通道充值
按发布顺序轮询已确认的收款通道充值,游标只向前推进,任何一笔已结算的付款都不会被跳过或重复。
GET
获取通道充值
读取任意状态下的单条收款通道充值,含冻结的费率快照、总额手续费与实收金额,以及它的链上凭据。
POST
模拟通道充值
把沙箱的收款通道充值推到 confirming、reorged 或 confirmed,并收到与真实链上付款相同的 webhook。
Webhook
Webhooks
用签名的、按环境隔离的 webhook 端点和完整的投递工作流,把 Paymos 接入你的后端。
Webhook 事件
处理全部 16 种 Paymos webhook 事件类型,显式读取资源状态和终态语义。
Webhook 负载
读取带版本的 webhook 信封,以及 data 中完整的账单、转出或通道充值资源快照。
验证签名
用 HMAC-SHA256 验证 X-Webhook-Signature 请求头,安全比较签名,执行时间戳规则,并支持密钥轮换。
投递与重试
按约 16 小时内 11 次投递尝试设计,对重复事件去重,检查失败并在恢复后重放。
测试 webhook
在交互式文档演练场中走通真实的沙箱账单和 webhook 投递路径。
插件
WooCommerce 插件
为 WooCommerce 安装官方 Paymos 插件,安全连接项目凭证,测试结账流程,并通过带签名的 webhook 更新订单。
WHMCS 插件
为 WHMCS 账单添加稳定币付款,无需填写密钥即可连接 Paymos,测试 webhook,并保留现有的开通规则。
OpenCart 插件
为 OpenCart 安装官方 Paymos 扩展,无需复制 secret 即可连接店铺,并在测试模式下验证付款状态更新。
Easy Digital Downloads 插件
将 Paymos 接入 Easy Digital Downloads,测试稳定币订单,验证带签名的付款更新,并在确认后才释放文件。
CS-Cart 插件
为 CS-Cart 和 Multi-Vendor 安装官方 Paymos 扩展,连接项目,验证带签名的状态更新,并在上线前测试一笔订单。
Magento 2 插件
为 Magento 2 或 Adobe Commerce 安装 Paymos 模块,连接测试与正式凭证,并验证订单到账单的状态流转。
Shopware 6 插件
为 Shopware 6 安装 Paymos 插件,按销售渠道启用,验证带签名的交易更新,无需重装即可切换模式。
PrestaShop 插件
为 PrestaShop 8 或 9 添加 Paymos,安装模块并一键连接店铺,验证带签名的回调,并测试 Payment accepted 订单流转。