Revocar API Key

Revoca de forma inmediata una API Key del partner, desactivándola para que deje de autenticar consumo transaccional.

Propósito

Invalidar una credencial comprometida o fuera de uso.
Cortar acceso de la key en tenant storage y en índice master.

Seguridad

Requiere Authorization: Bearer access_token.
Scope requerido: apikey.manage.
Requiere headers firmados:
Idempotency-Key
X-Request-Id
X-Timestamp
X-Nonce
X-Signature
X-Signature-Key-Id
Content-Digest no es obligatorio en DELETE (si no hay body).

Path parameter

API_KEY_ID (string, requerido): id de la key a revocar.

Reglas de negocio

La key debe existir en el índice master.
La key debe pertenecer a un tenant del partner autenticado.
Revocación sincronizada:
tenant DB: isActive = false, status = 'revoked'
master index: isActive = false, status = 'revoked'

Respuesta exitosa 200

  "success": true,
  "apiKeyId": "69db39cad6c14afe9b126187",
  "status": "revoked",
  "revokedAt": "2026-04-12T19:00:00.000Z"
}

📌

Errores comunes

401 Unauthorized: token inválido/expirado o firma inválida.
403 Forbidden: scope insuficiente o key fuera del partner.
404 Not Found: API key inexistente.
409 Conflict: replay/idempotencia (si repites nonce/idempotency fuera de manejo esperado).

💡

Notas de firma

Método firmado: DELETE
Path firmado (según implementación actual):
/api-keys/{API_KEY_ID}
No usar el path completo /api/partner/v1/api-keys/{API_KEY_ID} en el canonical.
Si envías body vacío, no incluyas Content-Digest; la línea 4 del canonical queda vacía.

Canonical esperado (sin query, sin digest):

/api-keys/{API_KEY_ID}


{X-Timestamp}
{X-Nonce}
{Idempotency-Key}

Solicitud

Autorización

Proporciona tu token bearer en el encabezado

Authorization

al realizar solicitudes a recursos protegidos.

Ejemplo:

Authorization: Bearer ********************

Parámetros de ruta

Parámetros de Header

Parámetros del Body application/jsonRequerido

Ejemplos

curl --location --request DELETE 'https://stp.paydaymx.com/api/partner/v1/api-keys/69dc1041d6c14afe9b1266ec' \ --header 'Idempotency-Key: ' \ --header 'X-Request-Id: ' \ --header 'X-Timestamp: ' \ --header 'X-Nonce: ' \ --header 'X-Signature: ' \ --header 'X-Signature-Key-Id: v1' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "externalAccountId": "string", "tenantId": "string", "tenantName": "string", "owner": { "email": "string", "name": "string" }, "metadata": { "segment": "string" } }'

Solicitud

Respuestas