Documentación API

Transacciones de cobros de cuotas de préstamos

Platita S.A.

Fecha: 19/05/2015

Contenido
* Introducción
* Generalidades
* API Command /cuotas
* API Command /cobros
* API Command /reversar
Introducción

Documentación de los servicios disponibles en el API, capa entre los medios de pagos electrónicos y el core
del sistema de préstamos de Platita S.A. para el acceso a la información de manera remota.

Generalidades
El protocolo está basado en peticiones HTTP de dos tipos:
• GET
• POST

Respuesta básica
Las respuestas son de tipo JSON.
La respuesta siempre está encapsulada en un objeto JSON que tiene las siguientes propiedades
básicas:

Propiedad Tipo Descripción

estado String El estado de la respuesta obtenida
Los valores posibles
- OK
- ERROR
error String Contiene la información adicional del
error
datos Objeto Contiene la información de la petición
que está siendo respondida

Objeto error
El objeto error tiene las siguientes propiedades:

Propiedad Tipo Descripción

codigo String Código del error
descripcion String Descripción detallada del error

Formatos del API

Date
yyyy-MM-dd

Donde
yyyy: año formateado con cuatros dígitos
MM: mes formateado con dos dígitos
dd: día formateada con dos dígitos

Formato de Money
Ejemplo: 650000 (sin puntos ni coma)

Código de Moneda
GS: Guaraníes
Comando /cuotas

El comando sirve para obtener la lista de cuotas pendientes de un cliente específico

Ficha técnica:

URL

URL_BASE + /cuotas/

Métodos HTTP Aceptados:

GET

Entrada:

Propiedad Tipo Descripción

apikey String Código para identificar el servicio
usuario String Nombre de usuario que se conecta al
servicio
contrasena String Contraseña del usuario
documento String Numero de CI del cliente de préstamo

Ejemplo de la petición:

http://www.platita.com.py:8080/platita/cuotas?apikey=5bc400b9-5350-48cf-85c3-
37fca646e2c1&usuario=pexpress&clave=pExpress123&documento=3022706

Salida:

a. Si el comando fue ejecutado de manera correcta:

estado : OK
error : nulo
data : lista JSON, donde cada elemento es un objeto JSON que representa la lista de
cuotas pendientes a pagar con las siguientes propiedades.

Propiedad Tipo Descripción

codigocliente String Codigo del cliente
nombrecliente String Nombre y Apellido del cliente
documento String Nro. Documento del cliente
moneda String Código de la moneda
nrocredito Int Número del préstamo
nrocuota Int Número de la cuota
fechavencimiento Date Fecha de vencimiento de la cuota
importe Double Importe de la cuota
mora Double Importe de la mora
Ejemplo del JSON:

{
"estado": "OK",
"error": null,
"datos":
[
{
"codigocliente": 171,
"nombrecliente": "JUAN PEREZ",
"documento": "3025669",
"moneda": "GS",
"nrocredito": 313,
"nrocuota": 1,
"fechavencimiento": "2015-09-08",
"importe": 371000,
"mora": 0
},
{
"codigocliente": 171,
"nombrecliente": "JUAN PEREZ",
"documento": "3025669",
"moneda": "GS",
"nrocredito": 313,
"nrocuota": 2,
"fechavencimiento": "2015-10-08",
"importe": 371000,
"mora": 0
},
{
"codigocliente": 171,
"nombrecliente": "JUAN PEREZ",
"documento": "3025669",
"moneda": "GS",
"nrocredito": 313,
"nrocuota": 3,
"fechavencimiento": "2015-11-08",
"importe": 371000,
"mora": 0
}
]
}

b. Si no se pudo obtener la información del préstamo

estado : Error
error : Descripción detallada del error
datos : nulo

Ejemplo del JSON

{
"estado": "Error",
"error": "No existe el préstamo para el documento ingresado"
"datos": null
}

Ejemplo de errores posibles:

Usuario y/o contraseña incorrectos

No existe el préstamo para el documento ingresado
 Error de servidor interno
Servicio no implementado o api key inválido

Comando /cobros

El comando sirve para procesar el cobro de una o varias cuotas pendientes.

Los valores de los importe se deben enviar por la totalidad, no se aceptan pagos parciales
Para este medio de pago.
Se podrán hacer pagos de varias cuotas correlativas.

Ficha técnica:

URL

URL_BASE + /cobros/

Métodos HTTP Aceptados:

POST

Entrada:

Propiedad Tipo Descripción

apikey String Código para identificar el servicio
usuario String Nombre de usuario que se conecta al
servicio
clave String Contraseña del usuario
transaccion Long Número de transacción de la
operación de cobro
jsonvalue String JSON que contiene las cuotas a ser
canceladas

Ejemplo de la petición:

http://localhost:8080/platita/cobros?apikey=55836199-7d48-49ce-a4c9-
450460f10cec&usuario=pexpress&clave=pExpress123&transaccion=5665448777&jsonvalue=
[{"codigocliente":171,"nombrecliente":"JUAN
PEREZ","documento":"3025669","moneda":"GS","nrocredito":313,"nrocuota":1,"fechavenci
miento":"2015-06-08","importe":371000,"mora":0}]

Salida:

a. Si el comando fue ejecutado de manera correcta:

estado : OK
error : nulo
datos : Objeto que contiene el mensaje de cobro correcto

Propiedad Tipo Descripción

mensaje String Descripción del mensaje

b. Si no se pudo ejecutar el comando correctamente

 estado : Error
error : Descripción detallada del error
datos : nulo

Ejemplo de errores posibles:

Usuario y/o contraseña incorrectos

No existe la cuota o préstamo para el documento ingresado
Error de servidor interno
Servicio no implementado o api key inválido
Error general

Comando /revertir

El comando sirve para revertir el cobro a partir de la transacción realizada en el

cobro

Ficha técnica:

URL

URL_BASE + /revertir/

Métodos HTTP Aceptados:

POST

Entrada:

Propiedad Tipo Descripción

apikey String Código para identificar el servicio
usuario String Nombre de usuario que se conecta al
servicio
clave String Contraseña del usuario
transaccion Long Número de transacción de la
operación de cobro

Ejemplo de la petición:

http://localhost:8080/platita/revertir?apikey=3f5cadf7-2e53-4e19-bf08-
1560211fb348&usuario=ADMIN&clave=admin123&transaccion=5665448777

Salida:

c. Si el comando fue ejecutado de manera correcta:

estado : OK
error : nulo
datos : Objeto que contiene el mensaje de la correcta anulación

Propiedad Tipo Descripción

mensaje String Descripción del mensaje

Si no se pudo ejecutar el comando correctamente

estado : ERROR
error : Descripción detallada del error
datos : nulo

Ejemplo de errores posibles:

Usuario y/o contraseña incorrectos

No existe la transacción
Error de servidor interno
Servicio no implementado o api key inválido
Transacción inválida