На странице
Список
Постранично читайте свои платёжные каналы от новых к старым с курсорной навигацией и фильтрами по проекту, статусу и вашему идентификатору.
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, затем по идентификатору канала, оба по убыванию, поэтому порядок не меняется, пока вы листаете.
- —На последней странице
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 | Запрос подписан ключом выплат (rk_). |
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 | Параметр, которого нет в таблице выше. |
Полный каталог — в Кодах ошибок.