Suspender Llave

Visión General

Este endpoint se utiliza para suspender (desactivar temporalmente) una llave Bre-B específica asociada a la cuenta de un cliente.

Detalles del Endpoint

Parámetro

Descripción

Endpoint

https://api.paas.sandbox.co.passportfintech.com/v1/keys/:key_id/suspend

Método

PATCH

Encabezados

Content-Type: application/json, Authorization

Autenticación

Token de Acceso (Bearer Token)

Cuerpo de la Solicitud

  • No requiere cuerpo de solicitud

Ejemplo de Solicitud

curl --location --request PATCH 'https://api.paas.sandbox.co.passportfintech.com/v1/keys/67d9a207-1b46-4961-ad08-24a226e46397/suspend' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \

Cuerpo de la Respuesta

  • Código HTTP: 200 OK

  • La repuesta devuelve el estado de la Llave: SUSPENDED (suspendida)

Ejemplo de Respuesta

{ "created_at": "2025-10-04T00:56:49.752Z", "updated_at": "2025-10-04T01:19:48.247Z", "account_id": "450dfdce-da3d-4261-9226-84913169ab37", "id": "67d9a207-1b46-4961-ad08-24a226e46397", "status": "SUSPENDED", "key": { "key_type": "E", "key_value": "78L216DRQG@passportfintech.com" } }

Errores Comunes y Manejo

Código HTTP

Significado

Descripción

400

Bad Request

Campo id faltante o inválido.

401

Unauthorized

Token Bearer ausente o inválido.

403

Forbidden

Alcance insuficiente o falta de permisos para suspender la llave.

404

Not Found

No existe una llave con el id proporcionado.

Buenas Prácticas

  • Refresca los tokens OAuth antes de que expiren para evitar fallos de autenticación.

  • Valida previamente los datos de entrada como el id para reducir errores 400.

  • Usa la suspensión como medida temporal de seguridad antes de una cancelación definitiva.

  • Mantén registros de quién y cuándo se suspendió la llave para fines de auditoría.