Перейти к содержимому

API

На странице

Разблокировка

Возобновите зачисление депозитов на платёжный канал: сервер сам вернёт его в active или provisioning в зависимости от наличия адреса.

POST/v1/payment-channels/:payment_channel_id/unblock

API-ключ: Payment

Отменяет блокировку. Канал снова принимает депозиты по всем своим маршрутам.

Тело запроса не передаётся.

Какой статус вы получите

Статус выбираете не вы — сервер определяет его по тому, что у канала фактически есть:

Условие Итоговый статус
Хотя бы у одной сети уже есть адрес active
Ни одного адреса ещё нет provisioning

Подготовка сетей продолжается и во время блокировки, поэтому канал, заблокированный рано и разблокированный позже, обычно возвращается в active с большим числом готовых сетей, чем было.

Повторный вызов для канала, который не заблокирован, ничего не меняет и возвращает тот же канал с 200 OK.

Ответ (200 OK)

Полный объект канала в том же виде, что возвращает Чтение, со статусом, определённым по правилу выше.

Ошибки

Код HTTP Когда
payment_channels_disabled 503 Платёжные каналы не включены для вашего аккаунта в этой среде.
payment_key_required 403 Запрос подписан ключом выплат (rk_).
payment_channel_not_found 404 Идентификатор не соответствует ничему, доступному этому ключу.
field_invalid_format 400 Сегмент пути не является корректным идентификатором pc_.

Полный каталог — в Кодах ошибок.