Introducción
El objetivo de éste documento es exponer los Servicios, parámetros y requisitos para poder integrar a los sistemas.
URL
Entorno de Pruebas: http://IP:PORT/{servicio}/ws-cabal-bc/api
Entorno de Producción: http://IP:PORT/{servicio}/ws-cabal-bc/api
Header Request Parameter
Todos los request deberán contener los datos que se encuentran especificados.
| Key | Type | Description |
|---|---|---|
Content-Type | String | Tipo de codificación del cuerpo de la petición application/json |
usuario | String | Usuario asignado a la boca de cobranza. |
password | String | Password asignado a la boca de cobranza. |
Servicios
Lista de Entidades
Método que retorna el listado de las entidades que operan con CABAL.
Endpoint
/v1/listarEntidades
Request
| Key | Type | Description |
|---|---|---|
header | <estructura> | |
usuario | String | Usuario asignado a la boca de cobranza. |
password | String | Password asignado a la boca de cobranza. |
Response
| Key | Type | Description |
|---|---|---|
header | <estructura> | |
codReturn | String | = 0 (cero) es éxito en la recepción |
txtReturn | String | Texto explicativo del código de retorno |
data | <estructura> | |
| entidades | <lista> | |
| codigoEntidad | String | Código asignado a la entidad. |
| descripcion | String | Descripción del servicio. |
Solicitar Extraccion con OTP
Método previo a realizar una extracción con OTP. Cabal genera el OTP y deja disponibilizado al usuario.
Endpoint
/v1/extraccion/otp/solicitar
Request
| Key | Type | Description |
|---|---|---|
header | <estructura> | |
usuario | String | Usuario asignado a la boca de cobranza. |
password | String | Password asignado a la boca de cobranza. |
data | <estructura> | |
| codigoEntidad | String | Código de la entidad. |
| nroDocumento | String | Nro de documento del usuario de DIMO. |
| nroCuenta | String | Número de cuenta o últimos 4 números de la tarjeta. |
Response
| Key | Type | Description |
|---|---|---|
header | <estructura> | |
codReturn | String | = 0 (cero) es éxito en la recepción |
txtReturn | String | Texto explicativo del código de retorno |
data | <estructura> | |
| codSolicitud | String | Código de solicitud. |
Confirmar Extraccion con OTP
Método previo a confirmar una extracción con OTP.
Endpoint
/v1/extraccion/otp/confirmar
Request
| Key | Type | Description |
|---|---|---|
header | <estructura> | |
usuario | String | Usuario asignado a la boca de cobranza. |
password | String | Password asignado a la boca de cobranza. |
data | <estructura> | |
| codSolicitud | String | Código de la solicitud previamente realizada. |
| codigoOtp | String | Código OTP enviado al usuario. |
| importe | String | Importe de la operación(formato ISO, los 2 últimos numero son los decimales) |
| moneda | String | Tipo Moneda |
Response
| Key | Type | Description |
|---|---|---|
header | <estructura> | |
codReturn | String | = 0 (cero) es éxito en la recepción |
txtReturn | String | Texto explicativo del código de retorno |
data | <estructura> | |
| codTransaccion | String | Código de la transacción. |