Credenciales de pago
Se requiere una credencial master
Tipos de credencial
| Tipo | Descripción |
|---|---|
master | Credencial raíz del comercio. Se usa para administrar las demás credenciales. |
slave | Subcredenciales acotadas a una integración, sucursal o caso de uso específico. |
public_credential_id (Public Key) y un private_credential_id (Private Key) que se usan para autenticar en el API.Operaciones disponibles
Crear una credencial
Crea una nueva credencial en tu comercio y devuelve un par nuevo de llaves pública y privada.Campos de la solicitud:
Campos de la respuesta:
| Campo | Obligatorio | Descripción |
|---|---|---|
merchant_id | ✅ | El ID de tu comercio |
alias | Etiqueta legible para la credencial (por ejemplo, "Tienda Bogotá") | |
enable | Indica si la credencial queda activa al crearse. Por defecto es true. | |
hidden | Oculta la credencial en la interfaz de la Console | |
metadata | Objeto clave-valor personalizado para tu control interno |
| Campo | Descripción |
|---|---|
credential_id | ID interno único de esta credencial |
public_credential_id | Public Key — úsala como Public-Merchant-Id en las solicitudes al API |
private_credential_id | Private Key — úsala como Private-Merchant-Id en las solicitudes al API |
alias | Etiqueta asignada a la credencial |
metadata | Metadata adjuntada al momento de crearla |
Buscar credenciales
Devuelve una lista paginada de las credenciales asociadas a tu comercio, con filtros opcionales.Campos de la solicitud:
La respuesta devuelve un array
| Campo | Obligatorio | Descripción |
|---|---|---|
limit | ✅ | Cantidad máxima de credenciales a devolver |
merchantId | Filtra por ID de comercio | |
offset | Desplazamiento para la paginación | |
filter | Objeto de filtro — acepta alias, credentialId, publicCredentialId, privateCredentialId, merchantId |
data y un conteo total.Búsqueda avanzada
Busca credenciales por palabra clave en sus campos (alias, IDs). Es útil para encontrar rápido una credencial específica.Campos de la solicitud:
| Campo | Descripción |
|---|---|
searchTerm | Palabra clave a buscar en los campos de la credencial |
merchantId | Limita los resultados a un ID de comercio específico |
Activar o desactivar
Habilita o deshabilita una credencial identificada por su Cuerpo de la solicitud:
Las credenciales desactivadas dejan de aceptar solicitudes al API de inmediato. Puedes reactivarlas en cualquier momento con
credentialId (parámetro de ruta).| Campo | Obligatorio | Valores |
|---|---|---|
action | ✅ | "ACTIVATE" o "DEACTIVATE" |
"ACTIVATE".Actualizar una credencial
Actualiza el Campos de la solicitud:
alias o la metadata de una credencial existente. El ID de la credencial se envía como parámetro de ruta.| Campo | Obligatorio | Descripción |
|---|---|---|
merchantId | ✅ | El ID de tu comercio |
alias | Nueva etiqueta legible | |
metadata | Objeto metadata actualizado |
Regenerar una credencial
Genera nuevas llaves pública y privada para una credencial identificada por su Usa este endpoint si una credencial se ve comprometida o si quieres rotar las llaves como medida de seguridad.
public_credential_id (parámetro de ruta).⚠️ Las llaves anteriores se invalidan de inmediato. Todas las integraciones que usen las llaves anteriores dejarán de funcionar. Las llaves nuevas reemplazan a las anteriores de forma automática en todos los lugares donde la credencial esté referenciada en el sistema de Kushki.
Eliminar una credencial
Elimina una credencial de forma permanente. El
credentialId se envía como parámetro de ruta.⚠️ La eliminación es irreversible. Cualquier integración que use la credencial eliminada dejará de funcionar de inmediato.
Autenticación
Private-Merchant-Id en código del cliente ni del frontend.Usar 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:48:58