跳到正文

API

本页内容

获取

读取单个收款通道:每条网络的永久地址、该网络此刻接受的代币,以及你现行的费率。

GET/v1/payment-channels/:payment_channel_id

API 密钥: Payment

pc_ 标识读取单个通道。告诉付款人往哪里打钱之前,先调它:它返回每条网络当前的地址,以及那条网络此刻接受的代币。

响应 (200 OK)

{
  "id": "pc_2QhKZv6mRt9WdA3nYpLbXf",
  "project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
  "external_id": "customer-42",
  "status": "active",
  "is_accepting_payments": true,
  "is_fully_provisioned": false,
  "is_test": false,
  "applied_fee_percent": 1.0,
  "customer_fee_percent": 0,
  "networks": [
    {
      "network": "TRC20",
      "status": "active",
      "address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
      "tokens": [
        { "symbol": "USDT", "minimum_deposit": "1.00" },
        { "symbol": "USDC", "minimum_deposit": "1.00" }
      ]
    },
    {
      "network": "ERC20",
      "status": "active",
      "address": "0x9f2a6c1b4e8d7350ab11c9e5f0d2743b86ce41d9",
      "tokens": [
        { "symbol": "USDT", "minimum_deposit": "12.00" },
        { "symbol": "USDC", "minimum_deposit": "12.00" }
      ]
    },
    {
      "network": "SOL",
      "status": "provisioning",
      "tokens": [
        { "symbol": "USDC", "minimum_deposit": null }
      ]
    }
  ],
  "created_at": 1767225600,
  "updated_at": 1767225780
}

状态

状态 说明 接受充值
provisioning 已创建,还没有地址就绪
active 至少有一个地址存在
blocked 你把通道停用了

active 只进不退。通道产出第一个地址之后,就不会自己回到 provisioning——其余网络在后台继续,就绪一条出现一条。没有失败状态:开通会一直重试到成功。

is_accepting_payments 是你 UI 里唯一需要判断的开关。只有当项目处于活跃状态、通道未被停用,并且至少有一条网络同时具备地址和已接受的代币时,它才为 true

地址是永久的

通道拿到的地址永久属于该通道,绝不会重新分配给别人。缓存它,别在每次页面加载时重新拉。

有两件事确实会变,你的集成要跟上:

  • 每条网络的代币——在项目上启用或停用代币会改变 tokens 数组。只展示列出来的那些
  • 哪些网络出现——把某条网络的代币在项目上全部移除,该网络就从响应中消失。地址本身没有被删除,重新启用代币会带回同一个地址,但 API 不再返回的路线要停止展示

最低金额按网络和代币分别定

tokens 里的每一项是对象,不是代币代码:

字段 说明
symbol 代币代码,如 USDT
minimum_deposit 十进制字符串,以该代币自身的单位计。这条路线上能够入账的最小转账额

最低金额同时取决于代币网络,两端相差好几个数量级:同一种代币,在使用成本只有几分钱的链上和在成本以美元计的链上,限制完全不同。这个值每次读取都会重新获取,所以请直接用你正要展示的那个响应里的数字,不要写死在代码里。

低于最低金额的转账不会计入通道,也不会自行退回。把这个数字放在地址旁边展示。

当这条路线此刻报不出最低金额时,minimum_depositnull。这不代表该路线没有最低金额:它同样没有任何一个已知安全的金额,所以在数字回来之前,不要引导付款人往那里付。把 null 当成 0,正是收到一笔无法入账的付款的最快方式。

费率是当前值,不是历史值

applied_fee_percentcustomer_fee_percent 描述你今天的定价,仅供参考。具体某一笔付款的权威数字在记录它的那条充值上:那里带着自己冻结的费率,以及自己的 grossfeenet。见获取通道充值

错误

错误码 HTTP 何时出现
payment_channels_disabled 503 本环境下你的账户未开通收款通道
payment_key_required 403 请求用 Payout(rk_)key 签名
payment_channel_not_found 404 该 id 解析不到这个凭证可以看到的任何东西
field_invalid_format 400 路径段不是合法的 pc_ 标识

属于其他商户、另一个环境,或位于凭证作用域之外项目的通道,同样回 payment_channel_not_found——与根本不存在的通道完全一致,因此 API 永远不会确认它不打算给你看的东西。

完整目录见错误码