Estados de Cuenta

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.

Obtener un Estado de Cuenta

El endpoint /credit-lines/{credit-line-id}/statements/{id} te permite obtener un estado de cuenta específico del identificador dado.

Parámetros disponibles
Path Parameters
idstringrequired
credit-line-idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit-line-id}/statements/{id}
Ejemplo de respuestas
{
"data":{
"id":
"lst-2Lm1ZH2rmhP6F1NRRBRnpUwswwP"
"status":
"GENERATED"
"period":
"2020-07"
"header":{
...
}
"operations":[
...
]
"card_statements":[
...
]
"payments":[
...
]
"refinancings":[
...
]
}
}

Búsqueda de Estados de Cuenta

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.

Filtros

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

Inclusión de campos

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

Paginado

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

Ordenamiento

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.

Rango de fechas

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.

Parámetros disponibles
Query Parameters
filter[status]string
Indica el estado de los estados de cuenta a buscar
Ejemplo: CREATED
Enum: CREATEDGENERATED
filter[period][from]string(format: YYYY-MM)
Indica el período desde el cual se quieren buscar estados de cuenta
Ejemplo: 2023-03
filter[period][to]string(format: YYYY-MM)
Indica el período hasta el cual se quieren buscar estados de cuenta
Ejemplo: 2023-04
includestring
Sirve para incluir nodos de estado de cuenta
Ejemplo: rates,limits
Enum: user_personal_databilling_cyclesrateslimits
page[size]string
Indica el tamaño de la página de la respuesta de la búsqueda
Ejemplo: 10
page[number]string
Indica el nro de la página que se quiere obtener
Path Parameters
credit-line-idstringrequired
Detalle de respuestas
metaobject
dataarray

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit-line-id}/statements
Ejemplo de respuestas
{
"meta":{
"pagination":{
...
}
}
"data":[
0:{
...
}
]
}

Obtener último Estado de Cuenta

El endpoint /credit-lines/{credit-line-id}/statements/last te permite obtener el último estado de cuenta generado.

Parámetros disponibles
Path Parameters
credit-line-idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit-line-id}/statements/last
Ejemplo de respuestas
{
"data":{
"id":
"lst-2Lm1ZH2rmhP6F1NRRBRnpUwswwP"
"status":
"GENERATED"
"period":
"2020-07"
"header":{
...
}
"operations":[
...
]
"card_statements":[
...
]
"payments":[
...
]
"refinancings":[
...
]
}
}

Obtener el siguiente Estado de Cuenta

El endpoint /credit-lines/{credit-line-id}/statements/next te permite obtener el estado de cuenta del periodo en curso.

Parámetros disponibles
Path Parameters
credit-line-idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit-line-id}/statements/next
Ejemplo de respuestas
{
"data":{
"id":
"lst-2Lm1ZH2rmhP6F1NRRBRnpUwswwP"
"status":
"GENERATED"
"period":
"2020-07"
"header":{
...
}
"operations":[
...
]
"card_statements":[
...
]
"payments":[
...
]
"refinancings":[
...
]
}
}