Credenciales de Acceso

1. Crea tu aplicación y gestiona tus llaves de acceso; si ya las creaste continua con el Paso 2.

Consume la API Bóveda

2.0. Descarga SDK.

Para descargar los archivos SDK, envíe una solicitud dando clic AQUÍ.

2.1. Crea un usuario a través de la operación createUser.

URL Pruebas:

https://apiadmin.apps-pruebas.credibanco.com/testing/api-ia/pci-dss/api/v1/services/createUser

Método HTTP: POST

Parámetro Obligatoriedad Descripción
email SI Email del usuario
tyc SI String que acepta valores S o N para aceptar los términos y condiciones
firstName SI El nombre del usuario
lastName SI El apellido del usuario
userType SI Tipo de documento del usuario, 1(CC), 4(CE), 5(Pasaporte), 6(Otro)
documentNumber SI Número de documento del usuario
cellphone SI Número de celular del usuario
SI Número de CVV de la tarjeta del usuario
cardNumber SI Número de tarjeta del usuario
alias SI El alias que se le dará a la tarjeta
validDate SI Fecha de expiración de la tarjeta
cardType SI El tipo de tarjeta, sea cd(tarjeta de credito) o db(tarjeta de débito).

HTTP STATUS Status Code Message
400 05 El usuario ya existe.
400 07 Correo electrónico con formato invalido.
400 08 Campos con valor vacíos.
400 09 El tipo de documento debe ser 1(CC), 2(CE), 5(Pasaporte) o 6(Otro).
400 10 El usuario no aceptó los Términos y Condiciones.
400 11 El tipo de tarjeta no es válido.
400 12 La fecha de expiración de la tarjeta no es válida.
400 13 El número de celular no es válido.
500 14 Validaciones diarias excedidas. Favor de validar nuevamente el día de mañana.
500 15 Error al realizar el microdébito/reverso
500 16 Error desconocido al realizar la validación de titularidad de tarjeta.
500 17 Error al realizar el microdébito/reverso
200 18 Se requiere la validación de microdébito.
200 19 Validación de tarjeta exitosa.
500 20 No existe la identificación.
500 21 No coinciden los datos.
500 22 Válido con documento no vigente.
500 23 Tipo de documento errado.
500 24 El número de tarjeta no corresponde a la identificación dada.
500 25 La tarjeta existe, pero no es válida para transar.
500 26 El número no es de una tarjeta de crédito.
500 27 El teléfono no coincide.
500 28 El email no coincide.
500 29 Error general.
500 30 Cliente con tarjeta activa en entidad.
500 31 Cliente sin tarjeta activa en entidad.
500 32 Error desconocido en validación de datacredito.
500 33 Error al guardar el registro de usuario.
200 34 Registro de usuario exitoso.
500 36 Error al realizar la transacción.

2.2. Obtén el valor del micro-débito

2.2.1 En el caso de estar en la etapa de implementación (en producción este valor será enviado por la entidad bancaria), debe consumir el servicio getTrxVal

URL Pruebas:

https://apiadmin.apps-pruebas.credibanco.com/testing/api-ia/microdebit/api/v1/getTrxVal

Método HTTP: GET

Parámetro Tipo Obligatoriedad Descripción
identification String Opcional Número de identificación ingresado en el enrolamiento
email String Opcional Email ingresado en el enrolamiento
validationToken String Opcional validationToken generado por el servicio de createUser o addCard = SDK - Pluggin

HTTP status code Code Status
200 - Response correspondiente el microdebito se obtiene del campo trxVal
400 1 Debe enviar por lo menos un parámetro
404 2 No se ha encontrado registros con los parametros ingresados

Consume el API de Bóveda

3.1 Confirma el valor del valor del micro-débito a través de la operación ​​validateMicrodebit

URL Pruebas:

https://apiadmin.apps-pruebas.credibanco.com/testing/api-ia/services/api/v1/validateMicrodebit

Método HTTP: POST

Parámetro Obligatoriedad Description
value SI Valor que fue debitado al usuario de tipo String
token SI Token de validación de microdébito producto del registro, campo de tipo String

HTTP Status Status Code Message
500 04 Error al obtener valores desde el token de authorizacion.
200 39 Se valido exitosamente el microdébito. Usuario registrado
200 39 Se valido exitosamente el microdébito. Tarjeta registrada
400 40 Limite de intentos diarios excedido
400 41 Error al realizar la validación, estado de usuario no valido
500 41 Error al realizar la validación
500 41 Validación fallida

Consume el servicio commerceToPerson

URL Pruebas:

https://apiadmin.apps-pruebas.credibanco.com/testing/api-b2c/comercetoperson/api/v1/transfers/commerceToPerson

Método HTTP: POST

Campo Description Tamaño Tipo
uniqueCode Código único del comercio. 10 Alfanumérico
nit Número de identificación del comercio 20 Alfanumérico
orderCommerce Orden del comercio 10 Alfanumérico
emails Emails a los cuales les llega el reporte del resultado de la transacción 400 Alfanumérico
gmfActivo Indica si se calcula el 4*1000 1 Booleano(true,false)
transfers Lista en donde se diligencian todas las personas a las que se les realizara una transferencia. N/A N/A
identificationNumber Número de Identificación de la persona que va a recibir la transferencia 255 Alfanumérico
typeIdentification Tipo de identificación de la persona que va a recibir la transferencia. 1 Numérico(1=CC,4=CE)
amount Valor a transferir por persona 14 Numérico (entero)
References Campo comodín para enviar cualquier etiqueta (No hace nada solo se almacena en base de datos). La condición es que la key debe ser siempre diferente porque si son iguales reemplaza el valor, pero nunca quedan las 2. N/A Alfanumerico

Campo Descripción
uniqueCode Código único del comercio.
nit Número de identificación del comercio.
orderCommerce Orden del comercio.
generalResponse Objeto para las respuestas
statusCode Código de respuesta
message Mensaje de respuesta

StatusCode Code Message
409 1 La orden ya existe.
409 2 No hay información para a procesar
409 3 Orden no encontrada.
409 4 Error desencriptando tarjetas
409 5 Error con el key store
409 6 El usuario no existe en la base de datos
409 7 No hay tarjetas favoritas para recibir dinero
409 8 La tarjeta no es apta para recibir dinero.
409 9 Procesador no encontrado
409 10 Tarjeta no encontrada
200 200 Proceso B2C en ejecución

Consume la consulta de las transferencias

URL Pruebas:

https://apiadmin.apps-pruebas.credibanco.com/testing/api-b2c/comercetoperson/api/v1/transfers/consult

Método HTTP: POST

Campo Descripción Tamaño Tipo
uniqueCode Código único del comercio 10 Alfanumérico
nit Número de identificación del comercio. 20 Alfanumérico
orderCommerce Orden del comercio 10 Alfanumérico

Campo Descripción
uniqueCode Código único del comercio
nit Número de identificación del comercio
orderCommerce Orden del comercio
gmfActivo Indica si se calcula el 4*1000
successfulTransfers Cantidad de transferencias realizadas satisfactoriamente
failedTransfers Cantidad Transferencias fallidas.
totalAmountTransferred Valor total transferido.
totalAmountFailed Valor total que fue fallido
totalGmfTransfered Valor total del gmf de todas las transacciones satisfactorias.
totalGmfFailed Valor total del gmf de todas las transacciones fallidas
emails Emails a los cuales se les envió el reporte
creationDate Fecha de creación del registro en base de datos
orderDetailDTOs Contiene todas las transacciones realizadas.
documentNumber Número de identificación de la persona que recibe le dinero
documentType Tipo de identificación de la persona que recibe el dinero
transferredValue Valor transferido
gmf Cálculo del 4*1000 de la transferencia
statusCode Código de estado de la transacción.
message Mensaje de estado de la transacción
creationDate Fecha de creación del registro en base de datos
References Campo comodín para enviar cualquier etiqueta (No hace nada solo se almacena en base de datos). La condición es que la key debe ser siempre diferente porque si son iguales reemplaza el valor, pero nunca quedan las 2

Link de la colección de B2C 1.0

Dependencias B2C 1.0

Dependencias servicio commerceToPerson

Servicios del API de Bóveda:

1. CreateUser

2. ValidateMicrodebit

3. ValidateUserByDocument (si se requiere validar que el usuario se encuentre registrado o no)

Dependencias servicio consult

Servicios de transferencias:

1. commerceToPerson

Certificación

Para iniciar el proceso de Certificación, debes haber finalizado tu implementación con éxito. Inicia tu solicitud AQUÍ.

Collection

B2C 1.0 (Con PCI) - Para descargar el collection, haga un clic AQUÍ.

Glosario

Puedes consultar el glosario dando clic AQUÍ.

Español