Referência de API

Kairos - Documentação

Versão: 2.0.0-RC1.0
Endpoints: 5
Formato: OpenAPI 3.0.0

Endereço base https://api-sandbox-duq.bvopen.com.br/open-banking/financings/v1

Baixar a spec OpenAPI Ver toda a documentação

Nesta página 5 operações

Financings

GET Obtém os dados dos contratos de financiamentos
GET Obtém os dados do contrato de financiamento identificado por contractId
GET Obtém a lista de garantias vinculadas ao contrato de financiamento identificado por contractId
GET Obtém os dados do cronograma de parcelas do contrato de financiamento identificado por contractId
GET Obtém os dados de pagamentos do contrato de financiamento identificado por contractId

API de informações de operações de financiamentos do Open Banking 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, 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`. # Orientações 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. ## 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

Obtém os dados dos contratos de financiamentos

/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

Parâmetros

x-fapi-auth-date

string no header

Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a [RFC7231](https://tools.ietf.org/html/rfc7231).Exemplo: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string no header

O endereço IP do usuário se estiver atualmente logado com o receptor.

x-fapi-interaction-id

string no header

Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.

x-customer-user-agent

string no header

Indica o user-agent que o usuário utiliza.

page

integer (int32) na query

Número da página que está sendo requisitada (o valor da primeira página é 1).

page-size

integer (int32) na query

Quantidade total de registros por páginas.

Respostas

200: Lista de contratos obtida com sucesso.
400: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.
401: Cabeçalho de autenticação ausente/inválido ou token inválido
403: O token tem escopo incorreto ou uma política de segurança foi violada
404: O recurso solicitado não existe ou não foi implementado
405: O consumidor tentou acessar o recurso com um método não suportado
406: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8
422: A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
429: A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
500: Ocorreu um erro no gateway da API ou no microsserviço
default: Erro inesperado.

GET

Obtém os dados do contrato de financiamento identificado por contractId

/contracts/{contractId}

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

Parâmetros

contractId

string no caminho obrigatório

Identificador do contrato para todos os tipos de operação de crédito.

x-fapi-auth-date

string no header

Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a [RFC7231](https://tools.ietf.org/html/rfc7231).Exemplo: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string no header

O endereço IP do usuário se estiver atualmente logado com o receptor.

x-fapi-interaction-id

string no header

Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.

x-customer-user-agent

string no header

Indica o user-agent que o usuário utiliza.

Respostas

200: Dados do contrato de financiamento identificado por contractId
400: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.
401: Cabeçalho de autenticação ausente/inválido ou token inválido
403: O token tem escopo incorreto ou uma política de segurança foi violada
404: O recurso solicitado não existe ou não foi implementado
405: O consumidor tentou acessar o recurso com um método não suportado
406: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8
422: A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
429: A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
500: Ocorreu um erro no gateway da API ou no microsserviço
default: Erro inesperado.

GET

Obtém a lista de garantias vinculadas ao contrato de financiamento identificado por contractId

/contracts/{contractId}/warranties

Método para obter a lista de garantias vinculadas ao contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora

Parâmetros

contractId

string no caminho obrigatório

Identificador do contrato para todos os tipos de operação de crédito.

page

integer (int32) na query

Número da página que está sendo requisitada (o valor da primeira página é 1).

page-size

integer (int32) na query

Quantidade total de registros por páginas.

x-fapi-auth-date

string no header

Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a [RFC7231](https://tools.ietf.org/html/rfc7231).Exemplo: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string no header

O endereço IP do usuário se estiver atualmente logado com o receptor.

x-fapi-interaction-id

string no header

Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.

x-customer-user-agent

string no header

Indica o user-agent que o usuário utiliza.

Respostas

200: Lista de garantias vinculadas ao contrato de financiamento identificado por contractId
400: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.
401: Cabeçalho de autenticação ausente/inválido ou token inválido
403: O token tem escopo incorreto ou uma política de segurança foi violada
404: O recurso solicitado não existe ou não foi implementado
405: O consumidor tentou acessar o recurso com um método não suportado
406: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8
422: A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
429: A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
500: Ocorreu um erro no gateway da API ou no microsserviço
default: Erro inesperado.

GET

Obtém os dados do cronograma de parcelas do contrato de financiamento identificado por contractId

/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

Parâmetros

contractId

string no caminho obrigatório

Identificador do contrato para todos os tipos de operação de crédito.

page

integer (int32) na query

Número da página que está sendo requisitada (o valor da primeira página é 1).

page-size

integer (int32) na query

Quantidade total de registros por páginas.

x-fapi-auth-date

string no header

Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a [RFC7231](https://tools.ietf.org/html/rfc7231).Exemplo: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string no header

O endereço IP do usuário se estiver atualmente logado com o receptor.

x-fapi-interaction-id

string no header

Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.

x-customer-user-agent

string no header

Indica o user-agent que o usuário utiliza.

Respostas

200: Dados do cronograma de parcelas do contrato de financiamento identificado por contractId
400: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.
401: Cabeçalho de autenticação ausente/inválido ou token inválido
403: O token tem escopo incorreto ou uma política de segurança foi violada
404: O recurso solicitado não existe ou não foi implementado
405: O consumidor tentou acessar o recurso com um método não suportado
406: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8
422: A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
429: A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
500: Ocorreu um erro no gateway da API ou no microsserviço
default: Erro inesperado.

GET

Obtém os dados de pagamentos do contrato de financiamento identificado por contractId

/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

Parâmetros

contractId

string no caminho obrigatório

Identificador do contrato para todos os tipos de operação de crédito.

page

integer (int32) na query

Número da página que está sendo requisitada (o valor da primeira página é 1).

page-size

integer (int32) na query

Quantidade total de registros por páginas.

x-fapi-auth-date

string no header

Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a [RFC7231](https://tools.ietf.org/html/rfc7231).Exemplo: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address

string no header

O endereço IP do usuário se estiver atualmente logado com o receptor.

x-fapi-interaction-id

string no header

Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.

x-customer-user-agent

string no header

Indica o user-agent que o usuário utiliza.

Respostas

200: Dados de pagamentos do contrato de financiamento identificado por contractId
400: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.
401: Cabeçalho de autenticação ausente/inválido ou token inválido
403: O token tem escopo incorreto ou uma política de segurança foi violada
404: O recurso solicitado não existe ou não foi implementado
405: O consumidor tentou acessar o recurso com um método não suportado
406: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8
422: A sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
429: A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
500: Ocorreu um erro no gateway da API ou no microsserviço
default: Erro inesperado.

Vai integrar?

Fale com o nosso time técnico: liberamos um token de teste e um ambiente de homologação para a sua equipe desenvolver a integração.

Falar com o time