Estados de Cuenta

Este servicio permite consultar los Estados de cuenta de las distintas Líneas de crédito. Encuentra más información sobre los Estados de cuenta en nuestra documentación.

Obtener un Estado de Cuenta

El endpoint /credit-lines/{credit-line-id}/statements/{id} te permite obtener un resumen específico a partir de un ID de statement

Parámetros disponibles
Query Parameters
extendedstring
Permite obtener información adicional que no viene incluida en la respuesta, como el pdf_url.
Ejemplo: pdf_url
Enum: pdf_url
Path Parameters
idstringrequired
Identificador del estado de cuenta
Ejemplo: lst-2Lm1ZH2rmhP6F1NRRBRneXAmpLe
credit-line-idstringrequired
Identificador de la línea de crédito
Ejemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
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":[
...
]
"payment_options":[
...
]
"pdf_url":
"https://example.com"
}
}

Buscar 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

Puedes encontrar más información sobre cómo aplicar los filtros en la sección de Filtros y paginado.

Parámetros disponibles
Query Parameters
filter[status]string
Indica el estado de los estados de cuenta a buscar
Ejemplo: CREATED
Enum: CREATEDGENERATEDLAST
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
Incluye nodos opcionales en el 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 número de la página que se quiere obtener
Ejemplo: 2
sortstring
Especifica el orden de los resultados
Ejemplo: status,-period
Enum: statusperiod
Path Parameters
credit-line-idstringrequired
Identificador de la línea de crédito
Ejemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
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
Identificador de la línea de crédito
Ejemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
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":[
...
]
"payment_options":[
...
]
"pdf_url":
"https://example.com"
}
}

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
Identificador de la línea de crédito
Ejemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
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":[
...
]
"payment_options":[
...
]
"pdf_url":
"https://example.com"
}
}