API de informações de operações de financiamentos do Open Finance Brasil –Fase 2. API que retorna informações de operações de crédito do tipo financiamento, mantidas nas instituições transmissoras por seus clientes, incluindo dados como denominação, modalidade, número do contrato, tarifas, prazo, prestações, pagamentos (ao menos para os últimos 12 meses), amortizações, garantias, encargos e taxas de juros remuneratórios.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os endpoints.

A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos dados relacionados ao consentId específico relacionado.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado (consentId).
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.

Observação: No endpoint /contracts/{contratId}/payments a paginação ocorrerá sob os dados contidos no campo releases do tipo lista.

Permissions necessárias para a API Financings

Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:

/contracts

permissions:
GET: FINANCINGS_READ

/contracts/{contractid}

permissions:
GET: FINANCINGS_READ

/contracts/{contractid}/warranties

permissions:
GET: FINANCINGS_WARRANTIES_READ

/contracts/{contractid}/scheduled-instalments

permissions:
GET: FINANCINGS_SCHEDULED_INSTALMENTS_READ

/contracts/{contractid}/payments

permissions:
GET: FINANCINGS_PAYMENTS_READ

Financings

GET/contracts

Método para obter a lista de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento

GET/contracts{contractid}

Método para obter os dados do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora

GET/contracts{contractid}/warranties

Método para obter a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno.

GET/contracts{contractid}/scheduled-instalments

Método para obter os dados do cronograma de parcelas do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora

GET/contracts{contractid}/payments

Método para obter os dados de pagamentos do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora