Credenciales de pago
Requisito previo: usuario Credential Master
Operaciones 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 keys | PATCH | /payment-credentials/v1/credential/recover/{public_credential_id} |
| Delete credential | DELETE | /payment-credentials/v1/credential/{credentialId} |
Crea una credencial
POST /payment-credentials/v1/credential para generar un nuevo par de llaves pública/privada en tu cuenta de comercio.{
"merchant_id": "20000000103802320000",
"alias": "Integración ecommerce",
"enable": true,
"hidden": false
}{
"credential_id": "f4c644b64951620ab8952ad58pl63901",
"public_credential_id": "345213d7d1c64ba28eb88a3b4f1ab0b9",
"private_credential_id": "c381037a5bfb00f2bd0ee899eb85fllq",
"alias": "Integración ecommerce",
"metadata": null
}| Campo | Requerido | Descripción |
|---|---|---|
merchant_id | Sí | Identificador de tu comercio. |
alias | No | Etiqueta legible para esta credencial. |
enable | No | true para activarla de inmediato (valor por defecto). |
hidden | No | true para ocultarla en la Kushki Console. |
metadata | No | Pares clave-valor personalizados para tu propio seguimiento. |
Busca credenciales
POST /payment-credentials/v1/credential/search para obtener las credenciales de un comercio con filtros y paginación opcionales.{
"merchantId": "20000000103802320000",
"limit": 10,
"offset": 0,
"filter": {
"alias": "ecommerce",
"credentialId": "f4c644b64951620ab8952ad58pl63901"
}
}| Campo | Requerido | Descripción |
|---|---|---|
merchantId | Sí | Comercio a consultar. |
limit | Sí | Número de resultados a devolver. |
offset | No | Desplazamiento de paginación. |
filter.alias | No | Filtra por alias de la credencial. |
filter.credentialId | No | Filtra por ID de la credencial. |
filter.publicCredentialId | No | Filtra por llave pública. |
filter.privateCredentialId | No | Filtra por llave privada. |
data de objetos de credencial y un conteo total.Búsqueda avanzada
POST /payment-credentials/v1/credential/suggestions para encontrar credenciales con una búsqueda de texto libre sobre alias e IDs.{
"merchantId": "20000000103802320000",
"searchTerm": "ecommerce"
}Activa o desactiva
PATCH /payment-credentials/v1/credential/status/{credentialId} para habilitar o deshabilitar una credencial sin eliminarla.{
"action": "DEACTIVATE"
}Valor de action | Efecto |
|---|---|
ACTIVATE | Vuelve a habilitar una credencial desactivada previamente. |
DEACTIVATE | Deshabilita la credencial: las solicitudes que la usen serán rechazadas. |
Actualiza una credencial
PATCH /payment-credentials/v1/credential/{credentialId} para cambiar el alias o la metadata de una credencial existente. Las llaves pública y privada no se ven afectadas.{
"merchantId": "20000000103802320000",
"alias": "Nuevo alias",
"metadata": { "env": "production" }
}Regenera las llaves
PATCH /payment-credentials/v1/credential/recover/{public_credential_id} para rotar las llaves pública y privada de una credencial. Kushki propaga automáticamente las nuevas llaves a todas las integraciones activas que usaban las anteriores.WARNING
Elimina una credencial
DELETE /payment-credentials/v1/credential/{credentialId} para eliminar una credencial de forma permanente. Esta acción no se puede deshacer: cualquier integración que siga usando la credencial eliminada dejará de funcionar de inmediato.Autenticación
Uso de la API
🟢 Producción
🧪 Sandbox (UAT)
https://api.kushkipagos.com/Endpoints disponibles
Búsqueda avanzada
Encuentra credenciales con una palabra clave de texto libre sobre alias e identificadores.¿Tienes una sugerencia sobre esta documentación? Contáctanos.
Modified at 2026-09-11 14:40:08