本页内容
列表
以最新在前的顺序用游标翻阅你的收款通道,并按项目、状态或你自己的外部标识筛选。
GET/v1/payment-channels
API 密钥: Payment
返回该凭证可见的通道,最新的在前。用它把你自己的付款人记录和我们的对上,或者按你分配的 external_id 找通道。
查询参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
limit |
integer | 20 |
每页大小,1 到 100 |
cursor |
string | — | 上一页 next_cursor 给出的不透明游标 |
status |
string | — | active、blocked 或 provisioning。可重复传;同一个值传两次会被拒绝 |
external_id |
string | — | 精确匹配创建时提供的标识 |
project_id |
string | — | 限定到单个项目(prj_…) |
其他参数一律拒绝。这里没有 external_order_id,也没有 created_from / created_to——那是账单和转出的参数,不属于通道。
示例
GET /v1/payment-channels?limit=50&status=active&status=provisioning HTTP/1.1
Host: api.paymos.io
Authorization: HMAC-SHA256 pk_live_…:…
X-Request-Timestamp: 1767225660
响应 (200 OK)
{
"items": [
{
"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
},
{
"id": "pc_6BwTyH4nPl8QmZ2vKrJdSc",
"project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
"external_id": "customer-41",
"status": "provisioning",
"is_accepting_payments": false,
"is_fully_provisioned": false,
"is_test": false,
"applied_fee_percent": 1.0,
"customer_fee_percent": 0,
"networks": [
{
"network": "TRC20",
"status": "provisioning",
"tokens": [
{ "symbol": "USDT", "minimum_deposit": null },
{ "symbol": "USDC", "minimum_deposit": null }
]
},
{
"network": "ERC20",
"status": "provisioning",
"tokens": [
{ "symbol": "USDT", "minimum_deposit": null },
{ "symbol": "USDC", "minimum_deposit": null }
]
},
{
"network": "SOL",
"status": "provisioning",
"tokens": [
{ "symbol": "USDC", "minimum_deposit": null }
]
}
],
"created_at": 1767225540,
"updated_at": 1767225540
}
],
"next_cursor": "CfDJ8JvN…"
}
分页
排序先按 created_at、再按通道 id,都是倒序,因此翻页期间序列稳定。
- —最后一页的
next_cursor为null,这就是停止的信号 - —游标绑定生成它的那组筛选条件。改了
status、external_id或project_id还沿用旧游标,会拿到400 pagination_cursor_invalid——另一种做法是悄悄跳过你从未看到的行 - —游标签发 24 小时后过期,之后从第一页重新开始
- —超出凭证作用域的
project_id返回空页,而不是 404,因此 API 永远不会确认一个你看不到的项目是否存在
错误
| 错误码 | HTTP | 何时出现 |
|---|---|---|
payment_channels_disabled |
503 | 本环境下你的账户未开通收款通道 |
payment_key_required |
403 | 请求用 Payout(rk_)key 签名 |
pagination_cursor_invalid |
400 | 游标格式错误、已过期,或绑定的是另一组筛选条件 |
field_invalid_enum |
400 | status 取了未知值 |
field_invalid_format |
400 | project_id 不是合法的 prj_ 标识,或同一个 status 值传了两次 |
payment_channel_external_id_invalid |
400 | external_id 超过 128 字符 |
field_out_of_range |
400 | limit 超出 1 到 100 的范围 |
query_parameter_unknown |
400 | 传了上表之外的参数 |
完整目录见错误码。