El estado de cuenta está compuesto por diferentes secciones:
Información general del estado de cuenta, identificador, estado del mismo, detalles informativos del cliente y la URL al archivo PDF (si es que fue generado).
Cabecera del estado de cuenta, en la cual se incluye la línea de crédito asociada, el usuario, información de los periodos, limites y balance de la línea de crédito, cuotas a vencer, información de parcelamento, gastos de servicio, información relativa a tasas, montos del estado de cuenta anterior y datos de financiación del estado de cuenta actual.
Consumos por tarjeta, donde en cada uno de ellos se incluye el identificador de la tarjeta, los últimos cuatro dígitos, el monto total en moneda local y en moneda extranjera (dependiendo del país), y una lista de las transacciones.
De cada transacción, se expone la fecha de la misma, el número del voucher, monedas locales/extranjeras, montos locales/extranjeros y datos del comerciante.
El endpoint /credit-lines/{credit-line-id}/statements/{id}
te permite obtener un estado de cuenta específico del identificador dado.
El endpoint /credit-lines/{credit-line-id}/statements
te permite realizar una búsqueda de estados de cuenta filtrando según los atributos que especifiques.
Tendrás que especificar tus filtros como parámetros siguiendo este patrón: filter[campo]=valor
. Por ejemplo: filter[status]=CREATED
.
Para filtrar un atributo con varios valores posibles, deberás separar los valores con comas.
Veamos un ejemplo: filter[status]=CREATED,GENERATED
Algunos campos por defecto no se devuelven en la respuesta. Para poder incluir estos campos tienes que enviar el parámetro include
con los parámetros que desees incluir separados por comas. Por ejemplo: include=rates,limits
.
Los parámetros excluídos por defecto son:
user_personal_data
: información sensible correspondiente al tarjeta habiente que incluye nombre, apellido y domicilio.billing_cycles
rates
limits
Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver utilizando: page[number]=valor
y page[size]=valor
Podrás especificar el orden de los resultados con determinados parámetros que deberás enviar como una lista de strings en el filtro de tipo sort. Por ejemplo: /credit-lines/{credit-line-id}/statements?sort=status,period
.
El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: /credit-lines/{credit-line-id}/statements?sort=status,-period
.
Los atributos para ordenar son:
status
period
Si un parámetro es incorrecto o está mal escrito, responderemos con un error.
Hay un filtro para el campo period
, que podrás usar para obtener los estados de cuenta pertenecientes al rango de periodos que indiques. Por ejemplo: filter[period][from]=2022-07&filter[period][to]=2023-05
buscará todos los estados de cuenta cuyo period
esté comprendido en ese rango.
El endpoint /credit-lines/{credit-line-id}/statements/last
te permite obtener el último estado de cuenta generado.
El endpoint /credit-lines/{credit-line-id}/statements/next
te permite obtener el estado de cuenta del periodo en curso.