1. Web
EspaΓ±ol
  • English
  • EspaΓ±ol
  • Inicio
  • IntegraciΓ³n con MCP
  • Libraries & SDKs (Online Payments)
    • Notas de versiΓ³n
    • Mobile
      • Kushki Android
      • Kushki iOS ο£Ώ
      • ConfiguraciΓ³n ARM de Kushki iOS
    • Web
      • Kushki.js 🌐
      • kushki.js-hosted-fields
        • kushki.js Hosted Fields
        • Migrar a Kushki.js 2.0
        • Antifraud
          • Interfaces
            • SiftScienceObject
            • SecureInitRequest
            • SecureInitResponse
          • Methods
            • requestInitAntiFraud
            • requestSecureInit
            • requestValidate3DS
        • Card
          • CarApplePay interface
            • Interfaz ICardApplePay
          • Card-Interface
            • Interfaz ICard
            • Interfaz ICardSubscriptions
          • Errors
            • Lista de errores
          • Interfaces
            • MasterCardBrandingRequest
            • Interfaz ApplePayGetTokenOptions
            • Interfaz ApplePayOptions
            • ApplePayPaymentContact
            • AppleTokenResponse
            • CardFieldValues
            • CardOptions
            • DeviceTokenRequest
            • Fields
            • FormValidity
            • SecureDeviceTokenOptions
            • Styles
            • TokenResponse
            • Amount
            • Interfaz BrandByMerchantResponse
            • CardInfo
            • CardTokenResponse
            • DeferredByBinOptionsResponse
            • DeferredInputValues
            • DeferredValuesResponse
            • Field
            • FieldInstance
            • FieldValidity
            • VisaBrandingRequest
          • Methods
            • initApplePayButton
            • initCardToken
            • initSecureDeviceToken
            • MΓ©todo requestBrandsByMerchant
            • MΓ©todo requestDeviceToken
            • requestInitCardBrandingAnimation
          • Types
            • CssProperties
            • Moneda
            • FieldTypeEnum
        • Card Payouts
          • Card Payouts Interface
            • ICardPayouts
          • Enumerations
            • EnumeraciΓ³n `InputModelEnum`
          • Errors
            • Errores
          • Interfaces
            • CardPayoutOptions
            • CardPayoutSubscriptionTokenResponse
            • CardPayoutUniqueTokenResponse
            • Field
            • Fields
            • FieldValidity
            • Interfaz FormValidity
            • Interfaz `Styles`
          • Methods
            • initCardPayoutToken
          • Type Aliases
            • CardPayoutTokenResponse
            • InputTypeEnum
          • Types
            • CssProperties
        • Kushki
          • Methods
            • FunciΓ³n init
            • FunciΓ³n requestBankList
            • FunciΓ³n requestCommissionConfiguration
          • Classes
            • KushkiError
          • Interfaces
            • IKushki
            • KushkiOptions
            • CommissionConfigurationRequest
Home
PerΓΊ πŸ‡΅πŸ‡ͺMΓ©xico πŸ‡²πŸ‡½Ecuador πŸ‡ͺπŸ‡¨Colombia πŸ‡¨πŸ‡΄Chile πŸ‡¨πŸ‡±
Home
PerΓΊ πŸ‡΅πŸ‡ͺMΓ©xico πŸ‡²πŸ‡½Ecuador πŸ‡ͺπŸ‡¨Colombia πŸ‡¨πŸ‡΄Chile πŸ‡¨πŸ‡±
  1. Web

Kushki.js 🌐

Kushki.js es nuestra librerΓ­a de JavaScript para construir flujos de pago con tu propio estilo. Puedes recolectar toda la informaciΓ³n de la tarjeta de tu cliente y generar un token que guardarΓ‘ y enviarΓ‘ esos datos de forma segura a tus servidores.
We make it easier!
Importar Kushki.js
Uso
Ejemplos
One-time Payment
Recurring Charges
Payouts
Others
Referencia
One-time Payment
Cargos recurrentes
Dispersiones
Otros

Importar Kushki.js#

Option 1 - CDN
Usa una etiqueta script dentro de tu pΓ‘gina para agregar las funcionalidades. Al agregar el siguiente cΓ³digo a tu pΓ‘gina, se importarΓ‘.


Option 2 - NPM
Instala el npm con el siguiente cΓ³digo:


Luego, impΓ³rtalo a tu espacio de trabajo de desarrollo con el siguiente cΓ³digo:


Importante
Agrega las siguientes lΓ­neas a tu cΓ³digo solo si usas Angular 6 o una versiΓ³n superior junto con el paquete npm de Kushki. Esto ayuda con el problema que aparece cuando no es posible resolver 'net'/'global' u otros globales de node. Encuentra mΓ‘s informaciΓ³n en el repositorio de Angular en GitHub.
Agrega el siguiente cΓ³digo en tu proyecto:


Cada vez que ejecutes npm install, incluye el siguiente cΓ³digo en tu package.json como parte de los scripts de postinstall:


Uso#

Empieza creando tu Kushki: te permitirΓ‘ ejecutar todas las funciones disponibles en Kushki.js.


Requerido

PropiedadTipoDescripciΓ³nPredeterminadoValores posibles
merchantIdStringID de Kushki creado para tu comercio
inTestEnvironmentbooleanValor para definir si estΓ‘s en ambiente de producciΓ³n o de pruebasfalsetrue , false

Opcional

PropiedadTipoDescripciΓ³nPredeterminadoValores posibles
regionalBooleanDefine si se usa una IP estΓ‘tica para acceder a Kushkifalsetrue,false

Ejemplos#

Encuentra los mΓ©todos disponibles en nuestra librerΓ­a Kushki.js junto con ejemplos.

Ejemplos de pago ΓΊnico#

Nota: El token que entrega Kushki solo cifra y envΓ­a informaciΓ³n. Si quieres guardar la informaciΓ³n de la tarjeta para compras futuras, ve a la secciΓ³n Ejemplos de cargos recurrentes.
Card
Card Async
Apple Pay
Transfer In
Transfer In (MΓ©xico)
Cash In

requestToken()#

Para crear un token de tarjeta, puedes usar esta funciΓ³n:

Solicitud#



Requerido

PropiedadTipoDescripciΓ³nPredeterminadoValores posibles
amountStringEl monto que vas a cobrar, como string
currencyStringCΓ³digo de la moneda usadaUSDUSD, COP, CLP, UF, PEN, MXN
cardObjectLos datos de la tarjeta recolectados en un objeto card
callbackFunction(response)La funciΓ³n callback creada* Γ‰xito : { token: "90a9f2d93ba508c38971890454897fd4"} * Con la validaciΓ³n OTP activada : { token: "90a9f2d93ba508c38971890454897fd4", secureId: "5e44449e-869b-4fed-bbca-e1bfa5af53c3", secureService: "KushkiOTP"} * Error: { message:"error-message", code:"error-code", error: "error-message"}

Opcional

PropiedadTipoDescripciΓ³nValores posibles
monthsIntegerNΓΊmero de cuotas. Requerido solo para transacciones diferidas en ChileMΓ­nimo: 2, mΓ‘ximo: 48

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{ 
    "token": "90a9f2d93ba508c38971890454897fd4"
}

Esta es la respuesta cuando el comercio tiene activada la validaciΓ³n OTP:

{ 
    "token": "90a9f2d93ba508c38971890454897fd4",
    "secureId": "5e44449e-869b-4fed-bbca-e1bfa5af53c3",
    "secureService": "KushkiOTP"
}

Esta es la respuesta cuando el comercio tiene activada la validaciΓ³n 3DS:

{ 
    "token": "90a9f2d93ba508c38971890454897fd4",
    "secureId": "1c3a9ada-1287-4f8b-b1a9-dadf44a39dd3",
    "secureService": "3dsecure",
    "security": {
        "acsURL": "",
        "authenticationTransactionId": "OWgXwASsYPW4hr1ATcf0",
        "authRequired": true,
        "paReq": "sandbox",
        "specificationVersion": "1.0.2"
    }
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code",
  "error": "error-message"
}

requestSecureServiceValidation() para OTP#

Para validar el OTP que ingresΓ³ el cliente:

Solicitud#



Requerido

PropiedadTipoDescripciΓ³nValores posibles
secureServiceIdStringEl secureId que obtienes de la solicitud del token
otpValueStringNΓΊmero de tres dΓ­gitos que corresponde al OTPEn el sandbox del OTP, el valor cambia segΓΊn la moneda de la tarjeta de crΓ©dito: 155 para USD y PEN, 555 para COP y MXN, 150 para CLP
callbackFunction(response)La funciΓ³n callback creada* Γ‰xito : { isValid: true} * Error: { message:"error-message", code:"error-code", error: "error-message"}

Respuesta#

La siguiente respuesta llegarΓ‘ en la funciΓ³n (callback):

{
  "code": "OTP000", 
  "message": "ok"
}

Si la transacciΓ³n se declina por la autenticaciΓ³n, su resultado se incluye como parte de la respuesta del cargo con 322 y cualquiera de los subcΓ³digos especificados en la lista de cΓ³digos de error.

requestSecureInit()#

OPCIONAL. Este mΓ©todo te permite obtener el Json Web token (JWT) para integraciones 100% API con 3DS.

Solicitud#



Requerido

PROPIEDADTIPODESCRIPCIΓ“NVALORES POSIBLES
cardObjectNΓΊmero de bin (8 dΓ­gitos) recolectado en un objeto

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NTQ2NTY4ODYsImlhdCI6MTY1NDY0OTY4NiwiaXNzIjoiNWVhMzJmZDJmZjQ2NDU2OTY3YjUyNDliIiwianRpIjoiMDFhZTQyYWUtYzMyZS00YWRjLWFmOWQtZWVhMmFlNjRkMDkxIiwiT3JnVW5pdElkIjoiNWVhMzJmZDJhZDA3ZDIxYTM2OTc4OGFlIiwiUmVmZXJlbmNlSWQiOiI3ZjY1NzM5NS0yMDIwLTQ1ZjEtOTY4Mi05MzJiNTU5YWYzMWIifQ.JUkk70Kg4KlUYW7eIvsW8LoDhxJeG8P00VrJH9oQipc"
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code",
  "error": "error-message"
}

requestValidate3DS()#

OPCIONAL. Este mΓ©todo permite realizar la autenticaciΓ³n 3DS por parte del tarjetahabiente en caso de que sea requerida.
Β‘Ten en cuenta!
La autenticaciΓ³n 3DS con kushki.js solo funciona en una aplicaciΓ³n web. Si el usuario intenta pagar desde un dispositivo mΓ³vil, la autenticaciΓ³n 3DS no se realiza.

Solicitud#



Usa las siguientes tarjetas en modo de pruebas para asegurarte de que tu integración estÑ lista. Úsalas con cualquier CVV, 1234 como código OTP y fecha de expiración futura.
Transaction approved with 3DS authentication required:
4456528080389860
4456529267234200
4456529165328302
4456524869770255
4456523340069956
Transaction approved without 3DS validation:
4456540000000063
4456543371713314
4456541982068615
4456541249811088

ParΓ‘metros#


PROPIEDADTIPODESCRIPCIΓ“NVALORES POSIBLES
secureIdStringEl secureId que obtienes de la respuesta del token o del token de cargo recurrente
securityObjectEl objeto security que recibes en la respuesta del token
acsURLStringURL de la pΓ‘gina de challenge del emisor
authenticationTransactionIdStringID de la transacciΓ³n verificada por las marcas.
specificationVersionStringVersiΓ³n de 3D Secure
paReqStringEste parΓ‘metro contiene los datos de la transacciΓ³n comprimidos y codificados en Base64. Lo recibes de las marcas.
authRequiredBooleanIdentifica si el challenge 3DS es requerido o no.
callbackFunction(response)La funciΓ³n callback creada

Respuesta#

La siguiente respuesta llegarΓ‘ en la funciΓ³n (callback):

{isValid: true}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code"
}

Si la transacciΓ³n se declina por la autenticaciΓ³n, su resultado se incluye como parte de la respuesta del cargo con 322 y cualquiera de los subcΓ³digos especificados en la lista de cΓ³digos de error.

requestDeferred()#

Para obtener las opciones de diferido segΓΊn las configuraciones de diferido del comercio definidas en el Backoffice:

Solicitud#



Requerido

PropiedadTipoDescripciΓ³n
binStringEl bin que se va a validar para las opciones de diferido
callbackFunction(response)La funciΓ³n callback creada

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

Ecuador#

[
  {
    "name": "Diferido Cuota Fija sin intereses",
    "type": "04",
    "months": ["3", "6", "12"],
    "monthsOfGrace": ["1", "2"]
  },
  {
    "name": "Diferido Cuota Fija con intereses",
    "type": "01",
    "months": ["3", "6", "9"],
    "monthsOfGrace": []
  }
]

Chile: Cuotas Emisor y Cuotas Comercio disponibles#

[
  {
    "type": "ALL",
    "months": ["2", "3", "4", "...", "48"],
    "monthsOfGrace": []
  },
  {
    "type": "03",
    "months": ["2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"],
    "monthsOfGrace": []
  }
]
La funcionalidad de Cuotas Comercio (Merchant Installments) β€”identificada con el type especΓ­fico "03"β€” estΓ‘ actualmente en Beta.
ParΓ‘metroTipoDescripciΓ³nPaΓ­ses/Notas
namestringEl nombre de la opciΓ³n de pago diferido (p. ej., "Diferido con intereses," "Meses sin intereses," "Regular").Nota: Este campo no siempre viene en la respuesta.
typestringUn cΓ³digo que identifica el tipo de opciΓ³n de diferido.El valor puede ser un cΓ³digo especΓ­fico (p. ej., "001", "002") o la palabra clave "ALL" para paΓ­ses como PerΓΊ o Colombia, donde aplica a todas las opciones de diferido.
monthsstring[]Un array de los plazos de pago disponibles (nΓΊmero de meses).Requerido para pagos diferidos.
monthsOfGracestring[]Un array de los periodos de gracia disponibles en meses.Este campo es opcional y solo estΓ‘ presente si el banco o la tarjeta permite un periodo de gracia para ese tipo de diferido.
La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "code":"error-code",
  "message":"error-message",
}

requestBinInfo()#

Devuelve un objeto con la informaciΓ³n relacionada al bin de la tarjeta de crΓ©dito (los primeros ocho dΓ­gitos). Para los comercios chilenos, la respuesta ayuda a decidir si continuar con la solicitud de un token de tarjeta (cuando cardType es CREDIT) o con la solicitud de un token de card async (cuando cardType es DEBIT):

Solicitud#



Requerido

PropiedadTipoDescripciΓ³n
binStringLos primeros ocho dΓ­gitos de la tarjeta de crΓ©dito
callbackFunction(response)La funciΓ³n callback creada

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{
    "bank": "BANCO DE LA PRODUCCION S.A. (PRODUBANCO)",
    "brand": "visa",
    "cardType": "debit",
    "country": "Ecuador"
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):

{ 
  "code":"error-code",
  "message":"error-message",
}

Ejemplos de cargos recurrentes#

Card
Card Async
Apple Pay

requestSubscriptionToken()#

Para crear un token de cargo recurrente, puedes usar esta funciΓ³n:

Solicitud#



Requerido

PropiedadTipoDescripciΓ³nPredeterminadoValores posibles
cardObjectLos datos de la tarjeta recolectados en un objeto card
currencyStringCΓ³digo de la moneda usadaUSDUSD, COP, CLP, UF, PEN, MXN
callbackFunction(response)La funciΓ³n callback creada* Γ‰xito : { token: "90a9f2d93ba508c38971890454897fd4"} * Error: { message:"error-message", code:"error-code", error: "error-message"}

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{ 
  "token": "90a9f2d93ba508c38971890454897fd4"
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code",
  "error": "error-message" 
}

Esta es la respuesta cuando el comercio tiene activada la validaciΓ³n 3DS:

{
    "token": "oaACBE1012310zYTjE239227yqFRA8r7",
    "secureService": "3dsecure",
    "secureId": "e356d68d-3f31-4134-a9a7-8cba46b3cdac",
    "security": {
        "acsURL": "https://authentication.cardinalcommerce.com/ThreeDSecure/V1_0_2/PayerAuthentication?issuerIdΓ’aa20412b0063aca652facd9g4transactionId=Qhcf3XOjdZmjve336Vee2gb5rof1",
        "authenticationTransactionId": "1d8cf7jg5Bfn8Nj73mn7",
        "paReq": "eNpVUtluwjAQfPdXoH5A7DghtGixxFUViRt6iDfXGGJCDpykQL++doDSvu3sjtYzs4ZlqKXsLaQotWQwknnOt7Km1q2HyeIx6EW7w2dn09NjFXnxxn1gMG3P5YHBl9S5ShPmOsShgG8QmRVahDwpGHBx6AzGzKdXoH5A7DghtGixxpVUtluwjAQfPdXoH5A7DghtGixs4ZlqKXsLaQot0u4KqLQKRlUugzC4gP+AYQlHrPwqLImhgfj0cnKvMwUhnfprkj0hiwnSPAxn1gMG3P5YHBl9S5ShPmOsShOqLqJ7x73Gx2vVbgC0DwZoXklFCKXFpo0bcpu83qWht0u4KqLQKRlUugzC4gP+AYQlHrpfUGenfxtGEOl1jIRN0c3hECesjSRhmNC+62Nh7vy7otNVxQmtdkm3Ew/Jrv1Kp0X4elF8Pb6p/n2KH/k0skaqcyeVHfdaulqgoP20X4elF8Pb6p/n2KH/k0sv8=",
        "specificationVersion": "1.0.2",
        "authRequired": true
    }
}

Esta es la descripciΓ³n de esas variables:

ParΓ‘metroTipoDescripciΓ³n
authRequiredBooleanEste campo indica si se requiere un challenge 3DS o no.
acsURLStringSe refiere a la URL de la pΓ‘gina de challenge que el usuario debe superar (Access Control System)
specificationVersionStringSe refiere a la versiΓ³n de 3DS
authenticationTransactionIdStringID de la transacciΓ³n verificada por Visa y Mastercard
paReqStringPayer Authentication Request. Es un campo codificado en base64 que contiene informaciΓ³n de tu comercio y del tarjetahabiente, y que se envΓ­a al emisor para la autenticaciΓ³n.

Nota: si estΓ‘s probando en un ambiente UAT, debes enviar sandbox.

Una vez que recibas la respuesta del Token con la estructura anterior, debes enviar el objeto security a Kushki consumiendo el mΓ©todo requestValidate3DS:

requestSecureInit()#

OPCIONAL. Este mΓ©todo te permite obtener el Json Web token (JWT) para integraciones 100% API con 3DS.

Solicitud#



Requerido

PROPIEDADTIPODESCRIPCIΓ“NVALORES POSIBLES
cardObjectNΓΊmero de bin (8 dΓ­gitos) recolectado en un objeto

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NTQ2NTY4ODYsImlhdCI6MTY1NDY0OTY4NiwiaXNzIjoiNWVhMzJmZDJmZjQ2NDU2OTY3YjUyNDliIiwianRpIjoiMDFhZTQyYWUtYzMyZS00YWRjLWFmOWQtZWVhMmFlNjRkMDkxIiwiT3JnVW5pdElkIjoiNWVhMzJmZDJhZDA3ZDIxYTM2OTc4OGFlIiwiUmVmZXJlbmNlSWQiOiI3ZjY1NzM5NS0yMDIwLTQ1ZjEtOTY4Mi05MzJiNTU5YWYzMWIifQ.JUkk70Kg4KlUYW7eIvsW8LoDhxJeG8P00VrJH9oQipc"
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code",
  "error": "error-message"
}

requestValidate3DS()#

OPCIONAL. Este mΓ©todo permite realizar la autenticaciΓ³n 3DS por parte del tarjetahabiente en caso de que sea requerida.

Solicitud#



Usa las siguientes tarjetas en modo de pruebas para asegurarte de que tu integración estÑ lista. Úsalas con cualquier CVV, 1234 como código OTP y fecha de expiración futura.
Transaction approved with 3DS authentication required:
4456528080389860
4456529267234200
4456529165328302
4456524869770255
4456523340069956
Transaction approved without 3DS validation:
4456540000000063
4456543371713314
4456541982068615
4456541249811088
ParΓ‘metros

PROPIEDADTIPODESCRIPCIΓ“NVALORES POSIBLES
secureIdStringEl secureId que obtienes de la respuesta del token o del token de cargo recurrente
securityObjectEl objeto security que recibes en la respuesta del token
acsURLStringURL de la pΓ‘gina de challenge del emisor
authenticationTransactionIdStringID de la transacciΓ³n verificada por las marcas.
specificationVersionStringVersiΓ³n de 3D Secure
paReqStringEste parΓ‘metro contiene los datos de la transacciΓ³n comprimidos y codificados en Base64. Lo recibes de las marcas.
authRequiredBooleanIdentifica si el challenge 3DS es requerido o no.
callbackFunction(response)La funciΓ³n callback creada

Respuesta#

La siguiente respuesta llegarΓ‘ en la funciΓ³n (callback):

{isValid:true}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code"
}

Si la transacciΓ³n se declina por la autenticaciΓ³n, su resultado se incluye como parte de la respuesta del cargo con 322 y cualquiera de los subcΓ³digos especificados en la lista de cΓ³digos de error.
Si el valor de la variable authRequired es igual a true, se muestra el modal de validaciΓ³n OTP y tu cliente recibe por correo electrΓ³nico o mensaje de texto el valor que debe ingresar.
Si el valor de la variable authRequired es igual a false, el modal de validaciΓ³n OTP no se muestra.
La respuesta de esta llamada llega en la funciΓ³n callback. Si es positiva, envΓ­a el token al back-end para continuar con la transacciΓ³n.

requestDeviceToken()#


Este mΓ©todo es requerido para ejecutar pagos one-click. Encuentra mΓ‘s informaciΓ³n en nuestra guΓ­a para generar pagos One-Click.

Solicitud#



Requerido

PropiedadTipoDescripciΓ³nPredeterminadoValores posibles
subscriptionIdStringSubscriptionId que se creΓ³ previamente
callbackFunction(response)La funciΓ³n callback creada* Γ‰xito : { token: "90a9f2d93ba508c38971890454897fd4"} * Error: { message:"error-message", code:"error-code", error: "error-message"}
amount (solo requerido para la autenticaciΓ³n 3DS)ObjectEl valor de la compra
currency (solo requerido para la autenticaciΓ³n 3DS)StringCΓ³digo de la moneda usadaUSD, PEN

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{ 
  "token": "90a9f2d93ba508c38971890454897fd4"
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code",
  "error": "error-message" 
}

Ejemplos de dispersiones#

Cash Out

requestPayoutsCashToken()#

Para crear un token de Cash Out, puedes usar esta funciΓ³n:

Solicitud#



Requerido

PropiedadTipoDescripciΓ³nValores posibles
nameStringNombre del cliente
lastNameStringApellido del cliente
documentTypeStringTipo de documento con el que paga el cliente.CC, NIT, CE, TI, PP
documentNumberStringNΓΊmero de documento con el que paga el cliente
totalAmountNumberEl monto que vas a cobrar, como nΓΊmero
currencyStringCΓ³digo de la moneda usadaCOP
callbackFunction(response)La funciΓ³n callback creada* Γ‰xito : { token: "90a9f2d93ba508c38971890454897fd4"} * Error: { message:"error-message", code:"error-code", error: "error-message"}

Opcional

PropiedadTipoDescripciΓ³n
emailStringCorreo electrΓ³nico del cliente
paymentDescriptionStringUna descripciΓ³n del pago

Respuesta#

La respuesta exitosa llegarΓ‘ en la funciΓ³n (callback):

{ 
    "token": "90a9f2d93ba508c38971890454897fd4"
}

La respuesta de error llegarΓ‘ en la funciΓ³n (callback):#

{ 
  "message":"error-message", 
  "code":"error-code",
  "error": "error-message"
}

Otros ejemplos#

Estado del gateway
Comisiones
Card Branding Animation

getStatusGateway()#

Para obtener el estado de todos los mΓ©todos de pago configurados para un comercio especΓ­fico:

Solicitud#



Requerido

PropiedadTipoDescripciΓ³n
callbackFunction(response)The created callback function()

Respuesta#

La respuesta llegarΓ‘ en la funciΓ³n (callback):

[
    {
      "card": true,
      "transfer": true,
      "cash": true
    }
]

Referencia#

Encuentra los mΓ©todos disponibles en nuestra librerΓ­a Kushki.js. Puedes realizar las siguientes operaciones:
Pago ΓΊnico:
Crear un token de tarjeta
Solicitar una validaciΓ³n OTP. Si quieres mΓ‘s informaciΓ³n sobre esta funcionalidad, ve a nuestra secciΓ³n One Time Password
Obtener el JWT para integraciones 100% API con 3DS
Validar el challenge 3DS
Obtener las opciones de diferido por bin
Obtener la informaciΓ³n del bin
Crear un token de Card Async
Obtener la lista de bancos disponibles para Transfer In
Crear un token de Transfer In
Crear un token de Cash In
Cargos recurrentes:
Crear un token de cargo recurrente con tarjeta
Obtener el JWT para integraciones 100% API con 3DS
Obtener el token de un cargo recurrente especΓ­fico
Obtener un cargo recurrente con Async Card
Dispersiones:
Create a Cash Out token
Otros:
Obtener el estado de todos los mΓ©todos de pago configurados para un comercio especΓ­fico
Obtener la informaciΓ³n relacionada al cargo por comisiΓ³n configurado para un comercio especΓ­fico

Pago ΓΊnico#


NombreParΓ‘metrosDevuelveDescripciΓ³n
requestToken()card, amount, currency, months, callbackObjectDevuelve un token de una tarjeta de crΓ©dito. AsegΓΊrate de que estΓ©n fuera de tu formulario principal (PCI COMPLIANCE). Si el comercio tiene activada la validaciΓ³n OTP, este mΓ©todo tambiΓ©n devuelve un secureId y un secureService que puedes usar luego para validar el OTP.
requestSecureServiceValidation()secureServiceId, otpValue, callbackObjectDevuelve si el OTP es vΓ‘lido o no.
requestSecureInit()card, callbackObjectEste mΓ©todo te permite obtener el Json Web token (JWT) para integraciones 100% API con 3DS.
requestValidate3DS()secureId, security, acsURL, authenticationTransactionId, specificationVersion, paReq, authRequired, callbackObjectEste mΓ©todo permite realizar la autenticaciΓ³n 3DS por parte del tarjetahabiente en caso de que sea requerida.
requestDeferred()binBody, callbackObjectDevuelve un objeto con las opciones de diferido permitidas para comercios ecuatorianos, mexicanos y peruanos.
requestBinInfo()binBody, callbackObjectDevuelve un objeto con la informaciΓ³n relacionada al bin de la tarjeta de crΓ©dito.
requestCardAsyncToken()totalAmount, currency, returnUrl, email, description, callbackObjectDevuelve un token de card async
requestBankList()callbackObjectDevuelve la lista de bancos disponibles para Transfer In
requestTransferToken()bankId, amount, email, callbackUrl, documentType, documentNumber, currency, paymentDesc, userType, callbackObjectDevuelve un token de transfer in
requestTransferSubscriptionToken()email, callbackObjectDevuelve un token de transfer in (solo MΓ©xico)
requestCashToken()name, lastName,documentType, identification, email, totalAmount, currency,description, callbackObjectDevuelve un token de cash in

Cargos recurrentes#


NombreParΓ‘metrosDevuelveDescripciΓ³n
requestSubscriptionToken()card, currency, callbackObjectDevuelve un token de un cargo recurrente. AsegΓΊrate de que estΓ©n fuera de tu formulario principal (PCI COMPLIANCE).
requestSecureInit()card, callbackObjectEste mΓ©todo te permite obtener el Json Web token (JWT) para integraciones 100% API con 3DS.
requestValidate3DS()secureId, security, acsURL, authenticationTransactionId, specificationVersion, paReq, authRequired, callbackObjectEste mΓ©todo permite realizar la autenticaciΓ³n 3DS por parte del tarjetahabiente en caso de que sea requerida.
requestDeviceToken()subscriptionId, callbackObjectDevuelve el token de un cargo recurrente especΓ­fico.
requestSubscriptionCardAsyncToken()currency, email, cardNumber, callbackUrl, callbackObjectDevuelve un token de cargo recurrente con card async.

Dispersiones#


NameParametersReturnsDescription
requestPayoutsCashToken()name, lastName,documentType, identification, email, totalAmount, currency,paymentDescription, callbackObjectReturns a cash out token

Otros#


NombreParΓ‘metrosDevuelveDescripciΓ³n
getStatusGateway()callbackObjectDevuelve el estado de todos los mΓ©todos de pago configurados para un comercio especΓ­fico
getCommissionConfiguration()totalAmount, currency, callbackObjectDevuelve la informaciΓ³n relacionada al cargo por comisiΓ³n configurado para un comercio especΓ­fico
initCardBrandingAnimation()callback, constrained, color, sound, checkmarkObjectLa Card Branding Animation le da al usuario una confirmaciΓ³n clara de su pago.

ΒΏTienes una sugerencia sobre esta documentaciΓ³n? ContΓ‘ctanos.
Modified atΒ 2026-09-11 15:21:19
Previous
ConfiguraciΓ³n ARM de Kushki iOS
Next
kushki.js Hosted Fields
Built with