Credenciales de pago
public_credential_id (que se usa para tokenizar del lado del cliente) y un private_credential_id (que se usa para los cargos del lado del servidor).Se requiere una credencial maestra
Master-Credential). Las credenciales maestras están disponibles on demand — contacta a tu ejecutivo de cuenta de Kushki para obtener una.Endpoints de un vistazo
| Operación | Método | Endpoint |
|---|---|---|
| Create credential | POST | /payment-credentials/v1/credential |
| Search credentials | POST | /payment-credentials/v1/credential/search |
| Advanced search | POST | /payment-credentials/v1/credential/suggestions |
| Activate / Deactivate | PATCH | /payment-credentials/v1/credential/status/{credentialId} |
| Update credential | PATCH | /payment-credentials/v1/credential/{credentialId} |
| Regenerate credential | PATCH | /payment-credentials/v1/credential/recover/{public_credential_id} |
| Delete credential | DELETE | /payment-credentials/v1/credential/{credentialId} |
Crear una credencial
POST /payment-credentials/v1/credential — genera un nuevo par de llaves pública/privada para un comercio.{
"merchant_id": "20000000103802320000",
"alias": "Producción México",
"enable": true,
"hidden": false
}201:{
"credential_id": "45fe3a3ebe464ebb100f2aa344b6a095",
"public_credential_id": "4da3fc210f0013bb2abfac6cfbabed65",
"private_credential_id": "sk_live_abc123...",
"alias": "Producción México"
}| Campo | Obligatorio | Descripción |
|---|---|---|
merchant_id | ✅ | La cuenta de comercio para la que se crea la credencial |
alias | Opcional | Etiqueta legible para la credencial |
enable | Opcional | true para crear la credencial como activa (por defecto: true) |
hidden | Opcional | true para ocultar la credencial en la Kushki Console |
metadata | Opcional | Metadata personalizada de tipo clave-valor |
Buscar credenciales
POST /payment-credentials/v1/credential/search — lista paginada de las credenciales de un comercio.{
"merchantId": "20000000103802320000",
"limit": 20,
"offset": 0,
"filter": {
"enable": true
}
}{
"total": 3,
"data": [...]
}| Campo | Obligatorio | Descripción |
|---|---|---|
merchantId | ✅ | Comercio del que quieres buscar credenciales |
limit | ✅ | Máximo de resultados por página |
offset | Opcional | Desplazamiento de la paginación (empieza en 0) |
filter | Opcional | Objeto de filtro (por ejemplo, por estado enable) |
Búsqueda avanzada
POST /payment-credentials/v1/credential/suggestions — obtén el detalle de una credencial por palabra clave (alias, fragmento de ID, etc.).{
"merchantId": "20000000103802320000",
"searchTerm": "Producción"
}{ "total": N, "data": [...] }.Activar o desactivar
PATCH /payment-credentials/v1/credential/status/{credentialId} — habilita o inhabilita una credencial.{
"action": "DEACTIVATE"
}Valor de action | Efecto |
|---|---|
ACTIVATE | Vuelve a habilitar la credencial |
DEACTIVATE | Inhabilita la credencial — las transacciones que usen esta llave se rechazan |
Actualizar una credencial
PATCH /payment-credentials/v1/credential/{credentialId} — actualiza el alias o la metadata de una credencial.{
"merchantId": "20000000103802320000",
"alias": "Nuevo alias",
"metadata": {
"env": "production"
}
}Regenerar una credencial
PATCH /payment-credentials/v1/credential/recover/{public_credential_id} — genera un nuevo par de llaves pública y privada para la credencial. Las llaves antiguas se reemplazan automáticamente en todas las integraciones que las estén usando.⚠️ Rotación de llaves: después de llamar a este endpoint, todas las integraciones que usen el public_credential_ido elprivate_credential_idantiguos reciben las llaves nuevas automáticamente. Considera una breve ventana de transición.
Eliminar una credencial
DELETE /payment-credentials/v1/credential/{credentialId} — elimina una credencial de forma permanente. Las credenciales eliminadas no se pueden recuperar.Autenticación
Uso de la API
🟢 Producción
🧪 Sandbox (UAT)
https://api.kushkipagos.com/Endpoints disponibles
¿Tienes una sugerencia sobre esta documentación? Contáctanos.
Modified at 2026-09-11 14:42:34