Cancela una llave Bre-b

PUT https://payment-backend-sandbox.milio.com.co/breb_keys/?id=UUID_DE_LA_LLAVE'

Cancela una llave Bre-b activa asociada a la empresa del usuario autenticado.

⚠️

El cuerpo del request debe estar encriptado y la respuesta también estará encriptada.

📌

Importante: El parámetro id debe ser el pk o UUID del registro de la llave Bre-b en el sistema, no el valor de la llave (@ML...).

---

Flujo de cancelación

La cancelación es asíncrona:

1. Se envía el request con el id de la llave a cancelar.
2. La API valida el estado de la llave de forma síncrona.
3. Si la validación pasa, se encola una tarea y se retorna un task_id inmediatamente.
4. La cancelación se procesa en segundo plano. Para conocer el resultado final, consulta el endpoint Obtener Estado de Tarea Asíncrona usando el task_id retornado.

Verificación 2FA

Si el usuario está autenticado mediante JWT, se requiere verificación de dos factores. Proporciona el campo otp_token en el cuerpo del request.

---

Parámetros de consulta (Query Parameters)

Parámetro	Tipo	Requerido	Descripción
id	string	✅ Sí	El pk o UUID del registro de la llave Bre-b a cancelar

---

Headers

Header	Tipo	Requerido	Descripción
X-API-KEY	password	✅ Sí	Tu llave de API
Content-Type	string	✅ Sí	application/json

---

---

La tarea fue encolada exitosamente. Usa el task_id para consultar el resultado final.

JSON

{
  "task_id": "abc123-...",
  "state": "PENDING",
  "result": null
}

Campo	Tipo	Descripción
task_id	string	ID de la tarea asíncrona. Úsalo en el endpoint Obtener Estado de Tarea Asíncrona
state	string	Estado inicial de la tarea (PENDING)
result	string	Será null inicialmente

❌ 400 — Error de validación síncrona

La API detectó un error antes de encolar la tarea. La respuesta incluirá un campo status_code indicando el problema. Causas comunes:

• INVALID_STATUS: La llave no está en estado ACTIVE (ya fue cancelada o está inactiva).

❌ 401 — No autorizado

La llave de API no fue enviada o es inválida.

❌ 403 — Prohibido

No tienes permisos para acceder a este recurso.

---

Errores asíncronos

Si la tarea falla al consultar el estado con task_id, el campo data.error_code puede contener:

Código	Descripción
AGENT_NOT_FOUND	Error técnico. No se pudo resolver el ID del agente bancario para esta llave
CANCELLATION_FAILED	Fallo genérico durante el proceso de cancelación