Ir al contenido

API

En esta página

Bloquear

Deja de atribuir depósitos nuevos a un canal de pago sin borrarlo, sin liberar sus direcciones y sin tocar los pagos que ya habías recibido.

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

Clave de API: Payment

Bloquear es la forma de dar de baja un canal. No hay borrado: la dirección que un cliente tiene apuntada nunca debe acabar cobrando para otra persona, así que el registro se queda, las vías se quedan y lo único que cambia es que dejas de recibir abonos por ahí.

Sin cuerpo de petición.

Qué hace el bloqueo

  • Los depósitos nuevos dejan de atribuirse a este canal.
  • status pasa a blocked e is_accepting_payments pasa a false.
  • Las direcciones no se liberan ni se reasignan. Siguen siendo de este canal para siempre.
  • Los depósitos ya recibidos no se tocan. Un depósito que estaba en confirming cuando bloqueas llega igual a confirmed, se contabiliza, dispara su webhook y aparece en el flujo.
  • El aprovisionamiento no se detiene. Las redes que todavía se estaban montando siguen su curso, así que desbloquear más adelante te devuelve un canal ya listo del todo.

Repetir la llamada sobre un canal ya bloqueado no tiene efecto: devuelve el mismo canal con 200 OK.

Respuesta (200 OK)

El objeto de canal completo, con la misma forma que devuelve Obtener, ya con status en blocked e is_accepting_payments en false. Todo lo demás, incluido el array networks entero, queda igual.

Errores

Code HTTP Cuándo
payment_channels_disabled 503 Los canales de pago no están activados para tu cuenta en este entorno.
payment_key_required 403 La petición se firmó con una clave Payout (rk_).
payment_channel_not_found 404 El id no resuelve a nada que esta credencial pueda ver.
field_invalid_format 400 El segmento de la ruta no es un identificador pc_ válido.

Consulta Códigos de error para el catálogo completo, y Desbloquear para revertirlo.