R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

DEFINICION DE INTERFACES WS

Introduccin

El actual proyecto de software bancario necesita ser flexible y escalable, por lo que se

pretende construir una aplicacin web en la que sus operaciones estn disponibles para

que otros sistemas se puedan adaptar e interactuar con nuestra aplicacin. Las interfaces

proporcionarn funcionalidades tanto para que las cuentas bancarias sean administradas

como para que los usuarios internos, clientes y accesos sean administrados, permitiendo

que otros sistemas bancarios administren toda esta informacin y agilicen el proceso de las

transacciones. El presente documento especificar la funcionalidad de cada interfaz, la

estructura del mensaje XML de peticin, la estructura del mensaje XML de respuesta, la

descripcin de cada parmetro en el mensaje XML, el objetivo de cada interfaz y el

responsable de cada interfaz.

PROPSITO

Especificar la funcionalidad de las interfaces y proporcionar una gua para su utilizacin.

Asegurar la correcta utilizacin del sistema para mantener la integridad de los montos en

las transacciones bancarias.

Lograr que los usuarios comprendan rpidamente la utilizacin de cada interfaz y la

informacin necesaria en cada una de ellas.

ALCANCE

Delimitar el funcionamiento de cada interfaz, especificando la funcionalidad, parmetros de

entrada y salida.

DEFINICIONES

Termino Definicin

Cliente Persona que hace uso de las funciones del banco.

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

Cuota Monto que forma parte de alguna transaccin en el

flujo bancario.

Saldo Monto total de la cuenta, prestamo o seguro.

Cuenta Entidad utilizada para manejar el saldo de algn

cliente.

Prstamo Monto que un cliente obtiene del banco y puede ser

devuelto por cuotas.

Seguro Monto del que un cliente puede hacerse acreedor

dependiendo de ciertas condiciones acordadas y

debe ser pagado en periodos de tiempo.

ABREVIATURAS Y ACRNIMOS

Abreviatura/Acrnimo Descripcin

Num Nmero

Cta. Cuenta

Tr. transaccin

ESTRUCTURA DEL DOCUMENTO

Seccin Descripcin

1 Introduccin

2 Propsito

3 Alcance

4 Definiciones

5 Abreviaturas y acrnimos

6 Estructuras del documento

7 Documento de referencia

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

8 Interfaces internas

DOCUMENTO DE REFERENCIA

Documento Versin Descripcin Origen

Estandares

de Servicios

Web

1 Definicin de los

estndares de

comunicacin y

contratos entre

servicios web

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

Interfaces Internas

No. Interfaz CrearCliente Responsable Hector Vix

Interfaz que permite el registro de un nuevo cliente dentro del sistema. Al

utilizar esta interfaz, el cliente que es creado no posee ninguna asociacin con

cuenta .

XML Request Nombre Parmetro Tipo - Descripcin

PrimerNombre String Primer nombre del nuevo cliente

SegundoNombre String Segundo nombre del nuevo cliente

PrimerApellido String Primer apellido del nuevo cliente

SegundoApellido String Segundo apellido del nuevo cliente

DPI String Documento personal de identificacin del nuevo cliente

Direccin String Direccin de residencia del nuevo cliente.

FechaNacimiento Date (dd/MM/YYY)

Fecha de nacimiento del nuevo cliente

PaisNacimiento String Pas de nacimiento del nuevo cliente

Telefono1 String Telefono de contacto

Telefono2 String Telefono de contacto 2 opcional.

Email String Email de contacto

XML Response

Nombre Parmetro Tipo - Descripcin

IdCliente Int64 Identificador interno del nuevo cliente.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

No. Interfaz ConsultarIDCliente Responsable Hector Vix

Interfaz que permite consultar el ID interno de algn cliente, teniendo los

datos personales del cliente.

XML Request Nombre Parmetro Tipo Descripcin

PrimerNombre String Primer nombre del nuevo cliente

SegundoNombre String Segundo nombre del nuevo cliente

PrimerApellido String Primer apellido del nuevo cliente

SegundoApellido String Segundo apellido del nuevo cliente

DPI String Documento personal de identificacin del nuevo cliente

Direccin String Direccin de residencia del nuevo cliente.

FechaNacimiento Date (dd/MM/YYY)

Fecha de nacimiento del nuevo cliente

PaisNacimiento String Pas de nacimiento del nuevo cliente

Telefono1 String Telefono de contacto

Telefono2 String Telefono de contacto 2 opcional.

Email String Email de contacto

XML Response

Nombre Parmetro Tipo - Descripcin

IdCliente Int64 Longitud

Resultado Bool True el resultado fue exitoso. False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz CrearCuenta Responsable Pedro Tay

Interfaz que permite crear y asociar una cuenta a un cliente.

XML Request Nombre Parmetro Tipo - Descripcin

Lista List Elemento que contiene una lista de clientes que coincidan con la bsqueda.

IdCliente Int64 Identificador interno del cliente.

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

MontoApertura Decimal Monto con el que se aperturar la cuenta.

XML Response

Nombre Parmetro Tipo - Descripcin

NumCuenta Int64 Numero de la cuenta creada.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz EliminarCuenta Responsable Pedro Tay

Interfaz que permite la eliminacin de alguna cuenta asociada a un cliente.

XML Request Nombre Parmetro Tipo - Descripcin

NumCuenta Int64 Numero de la cuenta creada.

XML Response

Nombre Parmetro Tipo - Descripcin

Resultado Bool True el resultado fue exitoso. False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz Depositar Responsable Hector Vix

Interfaz que permite realizar el depsito de un monto a una cuenta de un

cliente.

XML Request Nombre Parmetro Tipo - Descripcin

NumCuenta Int64 Nmero de cuenta destino del deposito

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

Monto Decimal Saldo a depositar

XML Response

Nombre Parmetro Tipo - Descripcin

NuevoSaldo Decimal Saldo luego de haber finalizado el deposito.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz Retirar Responsable Pedro Tay

Interfaz que permite realizar el retiro de un monto a una cuenta de un

cliente.

XML Request Nombre Parmetro Tipo - Descripcin

NumCuenta Int64 Nmero de cuenta destino del retiro.

Monto Decimal Saldo a retirar.

XML Response

Nombre Parmetro Tipo - Descripcin

NuevoSaldo Decimal Saldo luego de haber finalizado el retiro.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

No. Interfaz CrearPrestamo Responsable Hector Vix

Interfaz que permite crear un prstamo y asociarlo a un cliente.

XML Request Nombre Parmetro Tipo - Descripcin

IdCliente Int64 Nmero de cuenta a la que se asociar el nuevo prstamo.

Monto Decimal Monto del prstamo

XML Response

Nombre Parmetro Tipo - Descripcin

NumPrestamo Int64 Nmero del prstamo.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz PagarCuotaPrestamo Responsable Pedro Tay

Interfaz que permite pagar una cuota de algn prstamo asociado a un

cliente.

XML Request Nombre Parmetro Tipo - Descripcin

NumPrestamo Int64 Nmero del prstamo al cual se va a pagar la cuota.

Monto Decimal Saldo de la cuota.

XML Response

Nombre Parmetro Tipo - Descripcin

NuevoSaldo Decimal Saldo que an falta por pagar del prstamo.

CuotasFaltantes Int16 Numero de cuotas que an faltan por pagar.

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

Resultado Bool True el resultado fue exitoso. False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz ObtenerEstadoPrestamo Responsable Hector Vix

Interfaz que permite obtener el estado de un prstamo. Brinda informacin

sobre el saldo total del prstamo, el saldo que falta por pagar, el numero de

cuotas faltantes, el nmero de cuotas pagadas.

XML Request Nombre Parmetro Tipo - Descripcin

NumPrestamo Int64 Nmero del prstamo a consultar.

XML Response

Nombre Parmetro Tipo - Descripcin

ListaPago List Elemento que contiene una lista de los pagos realizados.

Pago Object Elemento que contiene los pagos realizados

MontoPago Decimal Monto del pago realizado.

FechaPago Date Fecha de la realizacin del pago

SaldoTotal Decimal Saldo total del prstamo.

SaldoFaltante Decimal Saldo que an falta por pagar.

CuotasPagadas Int16 Nmero de cuotas que han sido pagadas hasta el da actual.

CuotasTotales Int16 Nmero total de cuotas acordadas para el prestamo.

No. Interfaz CrearSeguro Responsable Pedro Tay

Interfaz que permite crear y asociar un seguro a un cliente.

XML Request Nombre Parmetro Tipo - Descripcin

IdCliente Int64 Nmero de cuenta a la que se asociar el nuevo seguro.

Monto Decimal Monto del seguro.

Descripcion String Descripcion del seguro

Comentario String Comentario

ListaBeneficiario Lista Elemento que contiene los nombres de beneficiarios y el porcentaje que

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

les corresponde

Beneficiario String Nombre beneficiario

PorcentajeBeneficio Decimal Porcentaje de beneficio del saldo del seguro.

XML Response

Nombre Parmetro Tipo - Descripcin

NumSeguro Int64 Nmero del seguro.

Resultado Bool True el resultado fue exitoso. False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz PagarSeguro Responsable Hector Vix

Interfaz que permite el pago de una cuota de un seguro asociado a un

cliente.

XML Request Nombre Parmetro Tipo - Descripcin

NumSeguro Int64 Nmero del seguro al cual se va a pagar la cuota.

Monto Decimal Saldo de la cuota.

XML Response

Nombre Parmetro Tipo - Descripcin

MesPagado Date Mes al que se abon el pago.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz ObtenerEstadoSeguro Responsable Pedro Tay

Interfaz que permite obtener el estado de pagos de algn seguro de un

R-PR Definicin de Interfaces WS

Definicin de Interfaces WS

Documentacin de Servicios

cliente.

XML Request Nombre Parmetro Tipo - Descripcin

NumPrestamo Int64 Nmero del prstamo a consultar.

XML Response

Nombre Parmetro Tipo - Descripcin

Estado String El estado de un seguro puede ser vigente o cancelado

MontoCuota Decimal Monto de la cuota mensual que se paga por el seguro.

UltimoMesPagado Indica el ultimo mes que el usuario pag el seguro.

Resultado Bool True el resultado fue exitoso.

False hubo error en el proceso.

Error String Si Resultado es False contendr la descripcin del error.

No. Interfaz HistorialCuenta Responsable Hector Vix

Interfaz que permite obtener el historial de una cuenta.

XML Request Nombre Parmetro Tipo - Descripcin

NumCuenta Int64 Nmero de la cuenta que se desea obtener el historial.

XML Response

Nombre Parmetro Tipo - Descripcin

Lista List Lista de transacciones realizadas

Tipo String Indica si fue un deposito o retiro

Monto Decimal Indica el monto de la transaccin.

Fecha Date(dd/MM/YYYY hh:mm:ss)

Indica la fecha y hora de la transaccin.