Page tree
Skip to end of metadata
Go to start of metadata

Introducción

El objetivo de éste documento es exponer los Servicios, parámetros y requisitos para poder integrar a los sistemas.

URL

  1. Entorno de Pruebas: http://IP:PORT/{servicio}/ws-cabal-bc/api

  2. 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.

KeyTypeDescription

Content-Type

String

Tipo de codificación del cuerpo de la petición application/json

Servicios

Lista de Entidades

Método que retorna el listado de las entidades que operan con CABAL.

Endpoint

/v1/listarEntidades

Request

KeyTypeDescription

header

<estructura>


   usuario

String

Usuario asignado a la boca de cobranza.

   password

String

Password asignado a la boca de cobranza.

Response

KeyTypeDescription

header

<estructura>


   codReturn

String

= 0 (cero) es éxito en la recepción
!= 0 es cualquier tipo de error/rechazo que pudo ocurrir

   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.

Deposito de Efectivo o Pago de Extracto

Método confirmar un deposito o pago de extracto.

Endpoint

/v1/deposito/confirmar

Request

KeyTypeDescription

header

<estructura>


   usuario

String

Usuario asignado a la boca de cobranza.

   password

String

Password asignado a la boca de cobranza.

data

<estructura>
   codigoEntidadStringCó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.

   importe

String

Importe de la operación(formato ISO, los 2 últimos numero son los decimales)

   moneda

String

Tipo Moneda

Response

KeyTypeDescription

header

<estructura>


   codReturn

String

= 0 (cero) es éxito en la recepción
!= 0 es cualquier tipo de error/rechazo que pudo ocurrir

   txtReturn

String

Texto explicativo del código de retorno

data

<estructura>
   codTransaccion

String

Código de la transacción.

  • No labels