Avla SSGE Asbanc API Reference

API para comunicacion con Asbanc

API Endpoint
http://localhost:8087/ssge-asbanc
Contact: desarrollo.pe@avla.com
Version: 1.0

1. Validacion

Verificar datos del cliente.

1. Validacion

Validación de Cliente

GET /validacion/validarCliente

Método a través del cual se valida el código de identificación ingresado por el cliente en el canal del banco es válido.

tipoConsulta: string 0, 1, 2
in query

Indica el criterio de consulta de la deuda del cliente.

idConsulta: string
in query

Dato de identificación para la consulta según el tipo de documento.

200 OK
ValidacionClienteResponseDto

OK

Response Content-Types: */*
Response Example (200 OK) 
{
  "nombreCliente": "Avla Peru Compañia de Seguros "
}

2. Consulta

Obtener deudas pendientes del cliente.

2. Consulta

Consulta de Deudas

POST /consulta/consultarDeuda

Método obligatorio que retorna las deudas asociadas al código de identificación ingresado en el canal del banco.

ConsultaDeudaRequestDto

request

Request Content-Types: application/json
Request Example
{
  "codigoBanco": "1020",
  "codigoProducto": "000",
  "idConsulta": "C3337",
  "tipoConsulta": "0"
}
200 OK
ConsultaDeudaResponseDto

OK

Response Content-Types: */*
Response Example (200 OK) 
{
  "codigoRespuesta": "00",
  "deudasPendientes": [
    {
      "anio": "2018",
      "codigoProducto": "3",
      "cuota": "string",
      "descDocumento": "PR010136",
      "deuda": 3293.32,
      "fechaEmision": "28062018",
      "fechaVencimiento": "13072018",
      "gastosAdm": 0,
      "monedaDoc": "1",
      "montoTotal": 3293.32,
      "mora": 0,
      "numDocumento": "P3002018010136",
      "pagoMinimo": 1,
      "periodo": "00"
    }
  ]
}

3. Pago

Pago de deudas y Anulación de pagos.

3. Pago

Extorno/Anulación de Pago

POST /pago/anularPago

Método obligatorio que indica que se tienen que revertir (Rollback) las deudas marcadas como pagadas en nuestro sistema y deben quedar como Pendientes de Pago.

AnulacionPagoRequestDto

request

Request Content-Types: application/json
Request Example
{
  "codigoBanco": "1020",
  "fechaTxn": "24082018",
  "horaTxn": "092000",
  "idConsulta": "C3337",
  "numOperacionBanco": "202408091501",
  "numOperacionERP": "256",
  "tipoConsulta": "0"
}
200 OK
AnulacionPagoResponseDto

OK

Response Content-Types: */*
Response Example (200 OK) 
{
  "codigoRespuesta": "00",
  "nombreCliente": "CONSORCIO SEÑOR DE BURGOS",
  "numOperacionERP": "257"
}
3. Pago

Notificación de Pago

POST /pago/notificarPago

Método que indica a nuestro sistema que se tienen que marcar las deudas enviadas como pagadas.

NotificacionPagoRequestDto

request

Request Content-Types: application/json
Request Example
{
  "canalPago": "10",
  "codigoBanco": "1020",
  "codigoProducto": "3",
  "fechaTxn": "24082018",
  "formaPago": "01",
  "horaTxn": "091500",
  "idConsulta": "C3337",
  "importePagado": 100,
  "monedaDoc": "1",
  "numDocumento": "P3002018010137",
  "numOperacionBanco": "202408091501",
  "tipoConsulta": "0"
}
200 OK
NotificacionPagoResponseDto

OK

Response Content-Types: */*
Response Example (200 OK) 
{
  "codigoRespuesta": "00",
  "nombreCliente": "CONSORCIO SEÑOR DE BURGOS",
  "numOperacionERP": "256"
}

Schema Definitions

DeudaPendienteDto: object

anio: string
codigoProducto: string
cuota: string
descDocumento: string
deuda: number
fechaEmision: string
fechaVencimiento: string
gastosAdm: number
monedaDoc: string
montoTotal: number
mora: number
numDocumento: string
pagoMinimo: number
periodo: string
Example
{
  "anio": "2018",
  "codigoProducto": "3",
  "cuota": "string",
  "descDocumento": "PR010136",
  "deuda": 3293.32,
  "fechaEmision": "28062018",
  "fechaVencimiento": "13072018",
  "gastosAdm": 0,
  "monedaDoc": "1",
  "montoTotal": 3293.32,
  "mora": 0,
  "numDocumento": "P3002018010136",
  "pagoMinimo": 1,
  "periodo": "00"
}

AnulacionPagoRequestDto: object

codigoBanco: string
fechaTxn: string
horaTxn: string
idConsulta: string
numOperacionBanco: string
numOperacionERP: string
tipoConsulta: string
Example
{
  "codigoBanco": "1020",
  "fechaTxn": "24082018",
  "horaTxn": "092000",
  "idConsulta": "C3337",
  "numOperacionBanco": "202408091501",
  "numOperacionERP": "256",
  "tipoConsulta": "0"
}

NotificacionPagoResponseDto: object

codigoRespuesta: string
nombreCliente: string
numOperacionERP: string
Example
{
  "codigoRespuesta": "00",
  "nombreCliente": "CONSORCIO SEÑOR DE BURGOS",
  "numOperacionERP": "256"
}

ConsultaDeudaRequestDto: object

codigoBanco: string
codigoProducto: string
idConsulta: string
tipoConsulta: string
Example
{
  "codigoBanco": "1020",
  "codigoProducto": "000",
  "idConsulta": "C3337",
  "tipoConsulta": "0"
}

ConsultaDeudaResponseDto: object

codigoRespuesta: string
deudasPendientes: DeudaPendienteDto
DeudaPendienteDto
Example
{
  "codigoRespuesta": "00",
  "deudasPendientes": [
    {
      "anio": "2018",
      "codigoProducto": "3",
      "cuota": "string",
      "descDocumento": "PR010136",
      "deuda": 3293.32,
      "fechaEmision": "28062018",
      "fechaVencimiento": "13072018",
      "gastosAdm": 0,
      "monedaDoc": "1",
      "montoTotal": 3293.32,
      "mora": 0,
      "numDocumento": "P3002018010136",
      "pagoMinimo": 1,
      "periodo": "00"
    }
  ]
}

ValidacionClienteResponseDto: object

nombreCliente: string
Example
{
  "nombreCliente": "Avla Peru Compañia de Seguros "
}

NotificacionPagoRequestDto: object

canalPago: string
codigoBanco: string
codigoProducto: string
fechaTxn: string
formaPago: string
horaTxn: string
idConsulta: string
importePagado: number
monedaDoc: string
numDocumento: string
numOperacionBanco: string
tipoConsulta: string
Example
{
  "canalPago": "10",
  "codigoBanco": "1020",
  "codigoProducto": "3",
  "fechaTxn": "24082018",
  "formaPago": "01",
  "horaTxn": "091500",
  "idConsulta": "C3337",
  "importePagado": 100,
  "monedaDoc": "1",
  "numDocumento": "P3002018010137",
  "numOperacionBanco": "202408091501",
  "tipoConsulta": "0"
}

AnulacionPagoResponseDto: object

codigoRespuesta: string
nombreCliente: string
numOperacionERP: string
Example
{
  "codigoRespuesta": "00",
  "nombreCliente": "CONSORCIO SEÑOR DE BURGOS",
  "numOperacionERP": "257"
}
Documentation by Spectacle