Extratos de Conta

Esse serviço permite consultar os extratos de conta das diferentes Linhas de crédito. Encontre mais informações sobre os Extratos de conta em nossa documentação.

Obter um Extrato de Conta

O endpoint /credit-lines/{credit-line-id}/statements/{id} permite que você obtenha um resumo específico a partir de um ID de statement

Parâmetros disponíveis
Query Parameters
extendedstring
Permite obter informações adicionais que não estão incluídas na resposta, como o pdf_url.
Exemplo: pdf_url
Enum: pdf_url
Path Parameters
idstringrequired
Identificador do extrato
Exemplo: lst-2Lm1ZH2rmhP6F1NRRBRneXAmpLe
credit-line-idstringrequired
Identificador de linha de crédito
Exemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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

Pesquisar Extratos de conta

O endpoint /credit-lines/{credit-line-id}/statements permite fazer uma pesquisa de extratos de conta filtrando pelos atributos que você especificar.

Filtros

Você pode encontrar mais informações sobre como aplicar filtros na seção de Filtros e paginação.

Parâmetros disponíveis
Query Parameters
filter[status]string
Indica o status dos extratos de conta a serem pesquisados
Exemplo: CREATED
Enum: CREATEDGENERATEDLAST
filter[period][from]string(format: YYYY-MM)
Indica o período a partir do qual deseja pesquisar os extratos
Exemplo: 2023-03
filter[period][to]string(format: YYYY-MM)
Indica o período até o qual deseja pesquisar extratos
Exemplo: 2023-04
includestring
Incluir nós opcionais no extrato de conta
Exemplo: rates,limits
Enum: user_personal_databilling_cyclesrateslimits
page[size]string
Indica o tamanho da página da resposta para os resultados da pesquisa
Exemplo: 10
page[number]string
Indicar o número da página desejada
Exemplo: 2
sortstring
Especificar a ordem dos resultados
Exemplo: status,-period
Enum: statusperiod
Path Parameters
credit-line-idstringrequired
Identificador de linha de crédito
Exemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Detalhe de respostas
metaobject
dataarray

Esta seção foi útil para você?

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

Obter último Extrato de Conta

O endpoint /credit-lines/{credit-line-id}/statements/last permite obter o último extrato de conta gerado.

Parâmetros disponíveis
Path Parameters
credit-line-idstringrequired
Identificador de linha de crédito
Exemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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

Obter o seguinte Extrato de Conta

O endpoint /credit-lines/{credit-line-id}/statements/next permite-lhe obter o extrato do período atual.

Parâmetros disponíveis
Path Parameters
credit-line-idstringrequired
Identificador de linha de crédito
Exemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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