Statements

This service allows you to inquire about the account statements for the different Credit Lines. Find more information about Account Statements in our documentation.

Get a Statement

The endpoint /credit-lines/{credit-line-id}/statements/{id} allows you to retrieve a specific statement based on a statement ID

Available parameters
Query Parameters
extendedstring
Allows you to obtain additional information that is not included in the response, such as the pdf_url.
Example: pdf_url
Enum: pdf_url
Path Parameters
idstringrequired
Statement identifier
Example: lst-2Lm1ZH2rmhP6F1NRRBRneXAmpLe
credit-line-idstringrequired
Line of credit ID
Example: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Response details
dataobject

Was this section helpful to you?

GET/lending/v1/credit-lines/{credit-line-id}/statements/{id}
Response examples
{
"data":{
"id":
"lst-2Lm1ZH2rmhP6F1NRRBRnpUwswwP"
"status":
"GENERATED"
"period":
"2020-07"
"header":{
...
}
"operations":[
...
]
"card_statements":[
...
]
"payments":[
...
]
"refinancings":[
...
]
"payment_options":[
...
]
"pdf_url":
"https://example.com"
}
}

Search Account Statements

The endpoint /credit-lines/{credit-line-id}/statements allows you to search statements by specifying attributes.

Filters

You can find more information on how to apply filters in the section Filters and pagination.

Available parameters
Query Parameters
filter[status]string
Indicate the status of the statements to be searched
Example: CREATED
Enum: CREATEDGENERATEDLAST
filter[period][from]string(format: YYYY-MM)
Indicate the period from which to search for account statements
Example: 2023-03
filter[period][to]string(format: YYYY-MM)
Indicate the period until which to search for statements
Example: 2023-04
includestring
Include optional nodes in the account statement
Example: rates,limits
Enum: user_personal_databilling_cyclesrateslimits
page[size]string
Indicate the size of the response page for the search results
Example: 10
page[number]string
Indicate the desired page number
Example: 2
sortstring
Specify the order of the results
Example: status,-period
Enum: statusperiod
Path Parameters
credit-line-idstringrequired
Line of credit ID
Example: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Response details
metaobject
dataarray

Was this section helpful to you?

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

Get Last Statement

The /credit-lines/{credit-line-id}/statements/last endpoint allows you to get the last generated statement.

Available parameters
Path Parameters
credit-line-idstringrequired
Line of credit ID
Example: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Response details
dataobject

Was this section helpful to you?

GET/lending/v1/credit-lines/{credit-line-id}/statements/last
Response examples
{
"data":{
"id":
"lst-2Lm1ZH2rmhP6F1NRRBRnpUwswwP"
"status":
"GENERATED"
"period":
"2020-07"
"header":{
...
}
"operations":[
...
]
"card_statements":[
...
]
"payments":[
...
]
"refinancings":[
...
]
"payment_options":[
...
]
"pdf_url":
"https://example.com"
}
}

Get the following Statement

The endpoint /credit-lines/{credit-line-id}/statements/next allows you to obtain the statement for the current period.

Available parameters
Path Parameters
credit-line-idstringrequired
Line of credit ID
Example: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Response details
dataobject

Was this section helpful to you?

GET/lending/v1/credit-lines/{credit-line-id}/statements/next
Response examples
{
"data":{
"id":
"lst-2Lm1ZH2rmhP6F1NRRBRnpUwswwP"
"status":
"GENERATED"
"period":
"2020-07"
"header":{
...
}
"operations":[
...
]
"card_statements":[
...
]
"payments":[
...
]
"refinancings":[
...
]
"payment_options":[
...
]
"pdf_url":
"https://example.com"
}
}