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

API

На странице

Блокировка

Прекратите зачислять новые депозиты на платёжный канал, не удаляя его, не освобождая адреса и не затрагивая уже полученные платежи.

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

API-ключ: Payment

Блокировка — это способ вывести канал из обращения. Удаления нет: адрес, сохранённый плательщиком, никогда не должен начать принадлежать кому-то другому, поэтому запись и маршруты остаются, а вы просто перестаёте получать по ним зачисления.

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

Что делает блокировка

  • Новые депозиты больше не зачисляются на этот канал.
  • status становится blocked, а is_accepting_paymentsfalse.
  • Адреса не освобождаются и не передаются другим. Они остаются за этим каналом навсегда.
  • Уже полученные депозиты не затрагиваются. Депозит, находившийся в confirming в момент блокировки, дойдёт до confirmed, будет проведён по учёту, отправит вебхук и появится в ленте.
  • Подготовка сетей не останавливается. Сети, которые ещё готовились, дойдут до готовности, поэтому после разблокировки канал будет полностью готов.

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

Ответ (200 OK)

Полный объект канала в том же виде, что возвращает Чтение: status теперь blocked, is_accepting_paymentsfalse. Остальные поля, включая весь массив networks, не меняются.

Ошибки

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

Полный каталог — в Кодах ошибок, обратное действие — Разблокировка.