NAV
Versão: v1.0.0-rc5.3

Introdução

Sejam bem-vindos à área do desenvolvedor do Portal do Open Banking Brasil

Nessa área os desenvolvedores encontrarão informações para observância obrigatória de todos os participantes, sejam eles obrigatórios ou voluntários, incluindo padrões técnicos de interfaces, glossário de termos técnicos, especificações dos diferentes tipos de APIs - incluindo seu versionamento, requisitos não funcionais como SLAs e limites de tráfego de requisições, informações de desempenho e disponibilidade, FAQ com diversas orientações aos desenvolvedores, entre outros elementos necessários à implementação do Sistema Financeiro Aberto. Todas as informações foram definidas de acordo com a regulamentação vigente no País, respeitando instruções normativas e resoluções do Banco Central do Brasil e do Conselho Monetário Nacional.

Este sítio eletrônico e seu conteúdo foram criados e são mantidos pela Estrutura responsável pela Governança do Open Banking Brasil, formada por integrantes de múltiplas associações: Febraban, ABBC, ACREFI, ABBI, OCB, Abecs, Abipag, Abranet, Câmara e-net, ABCD e ABFintechs.

Padrões

Estes padrões representam a versão 1.0.0, a qual fornece uma visão alto nível dos padrões. Consulte a seção versionamento para obter mais informações sobre como as versões são gerenciadas com o padrão.

Observe que, nesta proposta, as palavras-chave DEVEM, NÃO DEVEM, NECESSÁRIAS, RECOMENDADO, PODE e OPCIONAL, devem ser interpretadas conforme descrito na RFC2119.

Princípios

Os seguintes princípios técnicos não exaustivos constituem a base para o desenvolvimento e implementação das APIs para o Open Banking no Brasil:

Princípio 1: Segurança

A adoção de mecanismos de segurança no design e implementação das APIs do Open Banking no Brasil deverão considerar os padrões aplicáveis a cada uma de suas fases, visando a proteção e a disponibilidade do ecossistema como um todo, considerando clientes, participantes e os dados específicos compartilhados em cada fase.

Princípio 2: RESTful APIs

A API irá aderir aos conceitos de RESTful API sempre que for possível e sensato.

Princípio 3: Padrões existentes

Os padrões existentes serão adotados sempre que suas aplicações forem relevantes/apropriadas e desde que não violem nenhum dos demais princípios, com foco na experiência do desenvolvedor e do usuário, e ainda, prevendo a extensibilidade, resiliência e a evolução do Open Banking no Brasil.

Princípio 4: ISO 20022

Os payloads das APIs serão desenvolvidos utilizando como base os elementos e componentes de mensagem ISO 20022, que poderão ser modificados, caso necessário, para deixar o payload mais simples e/ou atender às características locais, tal como implementado em diferentes jurisdições.

Princípio 5: Extensibilidade

Os fluxos das APIs serão estendidos para atender a casos de uso mais complexos em futuros releases, e, portanto, esse princípio será mantido em mente durante o design, e os procedimentos serão detalhados durante a implementação.

Princípio 6: Códigos de Status

A API usará dois códigos de status que atendem a dois propósitos diferentes: (i) o HTTP status code reflete o resultado da chamada da API e (ii) um campo status em alguns resources payloads refletem o status dos resources nos casos de acesso write (p.ex. iniciação de pagamento).

Princípio 7: Identificadores únicos

Um recurso REST deverá ter um identificador exclusivo que possa ser usado para identificar o recurso, com formato e padrão a ser definido a partir da Fase 2 do Open Banking no Brasil.

Princípio 8: Categorização dos requisitos de implementação

Quando um requisito estiver sendo implementado por um transmissor e/ou um receptor, uma categorização diferente será aplicada. As funcionalidades, endpoints e campos em cada recurso serão categorizados como 'Obrigatório', 'Condicional' ou 'Opcional'.

Princípio 9: Agnósticas

As APIs serão agnósticas à implementação onde elas poderão ser consumidas independente das tecnologias adotadas no ecossistema, porém com aderência aos princípios contidos nesta documentação.

Versionamento

O controle de versão contemplará 4 tipos de lançamento (p.ex. major, minor, patch e release candidate) e terá prazos definidos para lançamento e implementação de novas versões major, bem como suporte de versões anteriores.

No link Anexo: Guia de Versionamento, integrante desta documentação, estão documentados os casos previstos em que uma nova versão de API poderá vir a quebrar o contrato estabelecido

O versionamento terá o seguinte formato contemplando 4 tipos de lançamentos de versões: 1.12.2.rc1 - significando versão major 1, versão minor 12 , aplicação de patchs versão 2 e release candidate 1

Será definido um cronograma de novas versões dos padrões para que os participantes consigam se planejar e desenvolver novas APIs. Cada lançamento terá prazo de implementação pré-estabelecido, mitigando, desta forma, o risco de múltiplas versões.

Não serão feitos mais do que um lançamento de versão major em um período de 6 meses. No entanto, estão previstas exceções para atender às alterações urgentes que não podem esperar até a próxima versão principal (major). Lançamentos de versões minor e patch podem ocorrer a qualquer momento.

Lançamentos minor não podem configurar em quebra de contrato, impactar significativamente endpoints e/ou exigir manutenção crítica.

Por fim, credenciais de acesso associadas às APIs deverão ser agnósticas à versão.

Estrutura da URI

A estrutura da URI para os endpoints deve ser implementada conforme abaixo:
<host> / open-banking / <api> / <versão> / <recurso>

Os componentes desta estrutura de URI estão descritos abaixo:

A versão minor será repassada apenas no header do payload de resposta, orientando a instituição receptora sobre quais serão os dados no retorno.

Como exemplo, para realizar o consumo do método electronic-channels da API channels na versão 1, a URI ficaria com a seguinte estrutura:

<host>/open-banking/channels/v1/electronic-channels

Cabeçalhos HTTP

Cabeçalhos HTTP suportados e suas funções.

Cabeçalho de requisição

Nome do cabeçalho Descrição Obrigatório
Content-Type Representa o formato do payload de requisição, por padrão/default definido como application/json;charset UTF-8. Obrigatório para chamadas PUT e POST. Os transmissores poderão implementar tratamento para outros padrões, sendo obrigatório apenas o suporte ao padrão. Não
Accept Especifica o tipo de resposta.
Se especificado, deve ser definido como application/json, a menos que o endpoint explicitamente suporte outro formato.
Se for definido um valor não suportado pelo endpoint, será retornado o código HTTP 406. Se não especificado, o padrão será application/json.
Não
Accept-Encoding Especifica os tipos de encoding(geralmente algoritmo de compressão) que são suportados pelo cliente, com previsão de suporte ao gzip por parte dos transmissores, sendo que o padrão é a transmissão dos dados não compactados e esta orientação aplica-se aos Dados Abertos. Não
If-Modified-Since Condiciona o resultado da requisição para que o recurso só seja enviado caso tenha sido atualizado após a data fornecida. Utiliza o padrão da RFC 7232, sessão 3.3: If-Modified-Since do protocolo HTTP. Não

Cabeçalho de resposta

Nome do cabeçalho Descrição Obrigatório
Content-Encoding Cabeçalho que indica o tipo de encoding (geralmente algoritmo de compressão) que foi utilizado para envio da resposta. Não
Content-Type Representa o formato do payload de resposta. Deverá ser application/json a menos que o endpoint requisitado suporte outro formato e este formato tenha sido solicitado através do cabeçalho Accept no momento da requisição. Sim
x-v Cabeçalho que indica a versão implementada da API pela instituição financeira. Deve ser preenchido com um número positivo, exemplo: x-v : 2 Sim
Retry-After Cabeçalho que indica o tempo (em segundos) que o cliente deverá aguardar para realizar uma nova tentativa de chamada. Este cabeçalho deverá estar presente quando o código HTTP de retorno for 429 Too many requests Não
Last-Modified Informa a data e hora em que o recurso foi modificado pela última vez. Utiliza o padrão da RFC 7232, sessão 2.2: Last-Modified do protocolo HTTP. Não

Códigos de resposta HTTP

Os códigos de resposta HTTP devem ser utilizados conforme tabela abaixo.

Códigos

Situação Código HTTP Notas POST GET DELETE
Consulta concluída com sucesso. 200 OK. Sim Sim Não
Execução normal. A solicitação foi bem sucedida. 201 Created. A operação resulta na criação de um novo recurso. Sim Não Não
Operação de exclusão concluída com sucesso. 204 No Content. Não Não Sim
A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. 400 Bad Request. A operação solicitada não será realizada. Sim Sim Sim
Cabeçalho de autenticação ausente/inválido ou token inválido. 401 Unauthorized. A operação foi recusada devido a um problema de autenticação. Sim Sim Sim
O token tem escopo incorreto ou uma política de segurança foi violada. 403 Forbidden. A operação foi recusada devido a falta de permissão para execução. Sim Sim Sim
O recurso solicitado não existe ou não foi implementado. 404 Not Found. Sim Sim Sim
O consumidor tentou acessar o recurso com um método não suportado. 405 Method Not Allowed. Sim Sim Sim
A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8. 406 Not Acceptable. Sim Sim Sim
Indica que o recurso não está mais disponível. 410 Gone. Sim Sim Sim
A operação foi recusada porque o payload está em um formato não suportado pelo endpoint. 415 Unsupported Media Type. Sim Não Não
A solicitação foi bem formada, mas não pôde ser processada devido à lógica de negócios específica da solicitação. 422 Unprocessable Entity. Se aplicável ao endpoint, espera-se que esse erro resulte em um payload de erro. Sim Sim Não
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. 429 Too Many Requests. A limitação é um Requisito Não Funcional. O titular dos dados deve incluir o cabeçalho Retry-After na resposta indicando quanto tempo o consumidor deve esperar antes de tentar novamente a operação. Sim Sim Sim
Ocorreu um erro no gateway da API ou no microsserviço. 500 Internal Server Error. A operação falhou. Sim Sim Sim
O serviço está indisponível no momento. 503 Service Unavailable. Sim Sim Sim
O servidor não pôde responder em tempo hábil. 504 Gateway Timeout. Retornado se ocorreu um tempo limite, mas um reenvio da solicitação original é viável (caso contrário, use 500 Internal Server Error). Sim Sim Sim

Convenções de payload

Esta seção do padrão descreve as estruturas padrões de requisição e resposta para todos os endpoints das APIs, assim como as convenções de nomenclatura para os atributos.

Estrutura de requisição

Estrutura da requisição

{
  "data": {
    "..."
  }
}

Cada requisição deve ser um objeto JSON contendo um objeto data para armazenar os dados primários da requisição.

No mesmo nível do objeto data, poderá existir um objeto meta se assim for especificado pelo endpoint. O objeto meta é usado para fornecer informações adicionais ao endpoint, como parâmetros de paginação, contagens de paginação ou outros propósitos complementares ao funcionamento da API.

A definição do conteúdo para o objeto data será definida separadamente para cada endpoint.

Estrutura de resposta

Estrutura de resposta

{
  "data": {
    "..."
  },
  "links":{
    "..."
  },
  "meta": {
    "..."
  }
}

Cada endpoint retornará um objeto JSON contendo os atributos abaixo:

A definição do conteúdo para os objetos data e meta será definida separadamente para cada endpoint.

O objeto links irá conter hypermedia (referências para recursos relacionados) para outros recursos da API requisitada.

O objeto de links sempre irá conter o atributo self que irá apontar para a URI da solicitação atual.

Estrutura de resposta de erros

{
  "errors": [
    {
        "code": "...",
        "title": "...",
        "detail": "..."
    }
  ],
  "meta":{
    "..."
  }
}

Convenções de nomenclatura de atributos

Caracteres válidos em nomes de atributos

Todos os nomes de objetos e atributos definidos nos objetos JSON de requisição e respostas devem ser nomeados seguindo o padrão camelCase, tendo seu nome composto apenas por letras (a-z, A-Z) e números (0-9).

Qualquer outro caractere não deve ser usado nos nomes dos objetos e atributos, com exceção do caractere - (hífen), que poderá ser utilizado apenas conforme descrito na seção Extensibilidade.

Estilo de nomeação de atributos

Os nomes dos objetos e atributos devem ser nomes significativos e em língua inglesa. Quando houver diferença entre inglês americano e inglês britânico no termo a ser utilizado, deverá ser utilizado o termo em inglês britânico. P.ex. Utilizar o termo Post Code (Reino Unido) ao invés de Zip Code (Estados Unidos).

Arrays devem ser nomeados no plural. Demais atributos deverão ser nomeados no singular.

Convenções de propriedade dos atributos

Tipos de dados dos atributos

Cada atributo deverá estar associado a um tipo de dado. A lista de tipos de dados válidos está definida na seção tipos de dados comuns. Se um tipo de dado personalizado é necessário para um atributo, o mesmo deverá ser classificado como uma string com uma descrição clara de como o valor da propriedade deve ser interpretado.

Atributos Obrigatórios / Opcionais

Segundo Instrução Normativa nº 34, BCB de 2020: ‘Todos os elementos que compõem as especificações das APIs (endpoints, operações, parâmetros, propriedades de respostas etc.) devem ser explicitamente declarados como “Obrigatório”, “Opcional” ou “Condicional”, caso sejam obrigatórios apenas em certas condições’.

Os atributos obrigatórios devem estar presentes e ter um valor não nulo, seja em uma requisição ou resposta, para que payload seja considerado válido.

Os atributos condicionais podem ter uma restrição vinculada a eles, tornando-os obrigatórios conforme a situação descrita na coluna 'restrição' do dicionário de dados.

Atributos vazios / nulos

Um atributo omitido (ou seja, um atributo que não está presente no payload) será considerado equivalente a um atributo que esteja presente com o valor null.

Uma string vazia (“”) não será considerada equivalente a null.

O valor booleano false não será considerado equivalente a null. Os atributos booleanos opcionais, por definição, possuirão três valores possíveis: verdadeiro (true), falso (false) e indeterminado (null).

Na situação onde o campo a ser informado no payload seja obrigatório e a Instituição, seja consumidora no envio ou transmissora no retorno, não a possuir, deve-se implementar o valor padronizado: “NA” - Não se Aplica, com exceção dos campos declarados como ENUM que deverão ser sempre preenchidos com os valores válidos para o ENUM correspondente.

Convenções de nomenclatura

Todos os nomes devem ser autoexplicativos, sem redundância de termos e sem ambiguidade de entendimento, além de seguir o padrão Lower Camel Case (primeira letra de cada termo maiúscula, com exceção do primeiro termo, que fica todo em minúsculas e sem espaços ou pontuações entre os termos). Ex: “areaCode”.

Os nomes das estruturas (composição de atributos sobre um assunto) que podem ter mais de uma ocorrência devem sempre estar no plural.

Os nomes dos atributos devem:

Tipos de dados comuns

Propriedades

Tipo Descrição Exemplos válidos
AmountString - Uma string que representa um valor monetário.
- Um número positivo, zero ou negativo.
- Sem o símbolo da moeda.
- Com pelo menos 1 e no máximo 16 dígitos antes do ponto decimal.
- Com no mínimo 2 dígitos (mais dígitos são permitidos, porém não obrigatórios).
- Sem formatação adicional. Ex: Separador de milhar.
"1.37"
"54.85"
"3456928.98"
"-2387.02"
Boolean - Valor booleano padrão. true
false
CurrencyString - Uma string que representa a abreviação da moeda conforme especificação ISO-4217. "BRL"
"USD"
"EUR"
DateTimeString - Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format). "2020-07-21T08:30:00Z"
DurationString - Uma string que representa um período de duração conforme especificação ISO-8601. "P23DT23H"
"PT2H30M"
Enum - Uma string que representa um domínio de valores
- Todos os possíveis valores são definidos.
- Os valores devem estar em letras maiúsculas.
- Espaços em branco devem ser substituídos por _.
- Artigos e preposições devem ser removidos.
- Não devem possuir caracteres acentuados.
"PRIMEIRA_OPCAO"
"OUTRA_OPCAO_EXISTENTE"
Integer - Números inteiros. -1
0
1
RateString - Uma string que representa um valor percentual, tendo como referência que 100% é igual ao valor 1.
- Com pelo menos 1 e no máximo 16 dígitos antes do ponto decimal.
- Com no máximo 16 dígitos após o ponto decimal.
- Sem formatação adicional. Ex: Separador de milhar.
"0.01"
"0.1"
"-0.05"
"-0.98365"
"0.1023"
String - Padrão de texto UTF-8 sem restrição de conteúdo. "Uma string qualquer."
TimeString - Uma string que representa a hora conforme especificação RFC-3339,sempre com a utilização de timezone UTC(UTC time format). "00:39:57Z"
URIString - Uma string que representa URI válida. "http://www.google.com.br"
CountryCode - Código do pais de acordo com o código “alpha3” do ISO-3166. "BRA"
IbgeCode - Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação. "3550308"
DateString - Uma string com data conforme especificação RFC-3339 "2014-03-19"

Paginação

Cada recurso de cada API pode possuir ou não paginação, caso a quantidade de registros retornados justifique a mesma. A paginação estará disponível e deverá funcionar independente se o recurso permitir filtros por query ou POST. Isso é, filtros e paginação serão aplicados de formas independentes.

Parâmetros de Requisição

Exemplo de query com paginação

GET {uri}?page=1&page-size=25

Quando existir paginação para o recurso deverão ser utilizados os parâmetros de query abaixo para a navegação dos resultados:

Parâmetro Descrição Valor Padrão
page Número da página que está sendo requisitada (o valor da primeira página é 1). 1
page-size Quantidade total de registros por páginas. 25

Atributos de Resposta

Exemplo de paginação

{
  "data": {
    "..."
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/personal-invoice-financing",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/personal-invoice-financing",
    "prev": null,
    "next": null,
    "last": "https://api.banco.com.br/open-banking/products-services/v1/personal-invoice-financing"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Além dos dados requisitados, as respostas paginadas também terão em sua estrutura dois objetos adicionais que incluirão parâmetros para facilitar a nagevação das páginas:

O objeto links passará por revisão subsequente de modo a atender às próximas fases do Open Banking, em especial a partir da Fase 2. No objeto links, retornará hypermedia (referências para os recursos relacionados) de paginação conforme parâmetros abaixo:

Parâmetro Descrição Restrição
first A URI para requisitar a primeira página. Obrigatório se a resposta não for a primeira página.
last A URI para requisitar a última página. Obrigatório se a resposta não for a última página.
prev A URI para requisitar a página anterior. Obrigatório se a resposta não for a primeira página.
next A URI para requisitar a próxima página. Obrigatório se a resposta não for a última página.

Meta

No objeto meta, retornará informações sobre o total de registros disponíveis

Parâmetro Descrição Restrição
totalRecords O número total de registros da requisição. Este atributo é obrigatório.
totalPages O número total de páginas da requisição. Este atributo é obrigatório. Se não possuir nenhum registro o valor deve ser 0.

Regras Adicionais

Estabilidade do ID

Dentro desses padrões, a serem melhor especificados a partir da Fase 2 do Open Banking no Brasil, os IDs de recursos são necessários nos seguintes casos:

Extensibilidade

Os padrões de Open Banking podem não cobrir todas as possibilidades de objetos retornados ou APIs que os participantes desejam expor. Os participantes podem ter o desejo de realizar inovações sobre os padrões definidos oferecendo mais dados afim de atender demandas específicas de mercado. É nossa intenção que os padrões definidos não apenas permitam estas extensões como também sirvam como base para futuras alterações na própria definição dos padrões.

No entanto, é importante que um participante que esteja querendo estender as APIs não impeça um consumidor que foi projetado para consumir apenas o endpoint padrão funcione corretamente.

Para atender tanto as demandas de quem deseja estender as APIs (participantes) quanto as demandas de quem irá realizar o consumo (consumidor das APIs), foram definidos os critérios abaixo.

É possível estender os padrões nos seguintes aspectos:

ID dos participantes

Cada participantes terá um ID que representa a sua instituição. Os participantes da atual versão estão listados abaixo:

  • BBAS - Banco do Brasil
  • BBCD - Bradesco
  • BTGP - BTG Pactual
  • CAIX - Caixa Econônica Federal
  • ITAU - Itau
  • STDR - Santander
  • BRGS - Banrisul
  • BNBR - Banco do Nordeste do Brasil
  • BNDS - BNDES
  • CITI - Citibank
  • SAFR - Safra
  • BABV - Votorantim

Participantes que desejam estender os padrões devem adicionar seu prefixo para identificar todas as extensões. Campos adicionais no retorno de endpoints existentes ou em novos endpoints devem usar o prefixo do participante. O prefixo deve ser no formato exposto ao lado (4 letras) e não devem haver prefixos duplicados entre os participantes.

Nesta documentação, quando tivermos que nos referir ao prefixo do participante, o termo <PID> será utilizado.

Novas APIs

Quando a extensão for a criação de uma nova API, o participante deve adicionar seu prefixo a URI antes do nome da nova API, conforme exemplo abaixo.

Por exemplo, uma API definida pelo padrão seguirá o seguinte formato: <host> / open-banking / <api> / <versão> / <recurso>

Uma API estendida por um participante deverá estar no formato abaixo: <host> / open-banking / <PID> / <api> / <versão> / <recurso>

Para os endpoints definidos dentro da estrutura acima, os atributos dos payloads não precisam conter o prefixo do participante, pois entende-se que todos os recursos da API estendida não conflitam de nenhum modo com as definidas pelo padrão.

Novos endpoints em APIs existentes

Quando o participante desejar adicionar um novo endpoint em uma API já especificada no padrão, deverá incluir seu <PID> como prefixo do recurso que será implementado.

Por exemplo, assumindo a existência do endpoint abaixo para consulta das transações de uma conta: <host>/open-banking/accounts/v1/accounts/{account ID}/transactions

Se o participante desejar adicionar um novo endpoint que resume as transações por um período, então este endpoint poderá ser definido como: <host>/open-banking/accounts/v1/accounts/{account ID}/<PID>-balance-movement

Campos de retorno adicionais em um endpoint existente

Quando o participante desejar adicionar um novo campo ao payload de resposta, o atributo deverá receber o prefixo do participante seguido por um hífen <PID>-.

Se um objeto for adicionado ao payload de resposta, apenas o nome do objeto precisará receber o prefixo. Qualquer atributo dentro do novo objeto poderá ser nomeado normalmente.

Parâmetros query adicionais

Quando for adicionado um novo parâmetro de query a um endpoint existente, o novo parâmetro deve ter o prefixo <PID>-, evitando assim colisões com parâmetros já existentes.

Filtro de Dados

Opcionalmente, a entidade transmissora de dados poderá realizar filtro de dados através de query de entrada, baseado em campos que julgue relevantes para a melhor experiência do cliente. As informações de quais possibilidades estarão disponíveis (query parameter) deverá constar em documentação adicional disponibilizada pela entidade transmissora.

Extensão do versionamento

Como descrito na seção versionamento, o versionamento existe apenas no nível das APIs e não no nível dos endpoints, no entanto caso seja necessário realizar versionamento de um endpoint customizado, o participante poderá utilizar o header x-<PID>-v para que o consumidor possa especificar qual versão do endpoint está requisitando.

Glossário

Glossário

Agência (Branch)

É a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória

Adiantamento a Depositante (Unarranged Account Overdraft)

O valor que o banco libera na conta-corrente do cliente, em casos excepcionais, o valor necessário para cobrir algum saque, pagamento, débito automático ou cheque, quando o saldo disponível não é suficiente.

Bandeira (Credit Card Network)

São instituições que autorizam o uso de sua marca e de sua tecnologia por emissores e credenciadoras de estabelecimentos. Essas marcas aparecem nos cartões e nos estabelecimentos credenciados.

CNPJ (CNPJ Number)

Código gerido pela Secretaria da Receita Federal e utilizado para identificação das empresas no Cademp. O CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Composto por: os oito primeiros números à esquerda (XX. XXX. XXX) formam a "raiz" ou base, que identifica a empresa de forma única. Os quatro seguintes números de ordem das filiais da empresa. Normalmente a empresa matriz tem este campo preenchido com '0001'. Os dois últimos números correspondem ao dígito verificador. composição do CNPJ pode ser assim representada, conforme ex. '50.685.362/0001-35'.

Conta de depósito à vista (Current Account)

Conhecida popularmente pelo nome de conta corrente. É a maneira mais comum de manter dinheiro em uma instituição financeira. Funciona como um cofre, em que o cliente deposita seu dinheiro e pode ter acesso a serviços como pagamento de contas, saques, transferências, emissão de cheques e realização de compras com cartão de débito, entre outros. Para guardar o dinheiro e oferecer serviços como os citados, a instituição financeira pode cobrar tarifas, mas o cliente é quem escolhe se prefere pagar uma tarifa individualizada por serviço que utilizar ou uma tarifa única que dá direito a um pacote de serviços.

Conta de pagamento pós-paga (Credit Card)

Referente a cartão de crédito. Instrumento de pagamento que possibilita a aquisição de produtos e serviços com liquidação futura, de acordo com requisitos predeterminados, tais como limite de crédito e validade. O pagamento do valor correspondente ao produto ou ao serviço adquirido será efetuado ao emissor do cartão de crédito em data previamente acordada.

Conta de pagamento pré-paga (Prepaid Payment Account)

Destinada à execução de transações de pagamento em moeda eletrônica realizadas com base em fundos denominados em reais previamente aportados.

Conta de Poupança (Saving Account)

A conta de depósitos de poupança, popularmente conhecida como conta poupança, conta de poupança ou ainda caderneta de poupança, é um tipo de investimento criado com o objetivo de estimular a economia popular. Assim, para abrir e manter uma conta de poupança, o cliente não paga tarifas, não paga imposto de renda sobre o dinheiro aplicado e ainda pode depositar pequenos valores, que passam a gerar rendimentos mensalmente. Se um valor depositado na conta de poupança não for mantido aplicado por pelo menos um mês, isto é, se for resgatado antes, não ocorrerá remuneração desse dinheiro.

Correspondente bancário (Banking Agent)

Empresas, integrantes ou não do Sistema Financeiro Nacional, contratadas por instituições financeiras e demais instituições autorizadas a funcionar pelo Banco Central do Brasil para a prestação de serviços de atendimento aos clientes e usuários dessas instituições. Os correspondentes mais conhecidos são as lotéricas e o banco postal.

Crédito Rotativo (Overdraft)

É um tipo de empréstimo que os bancos concedem para os clientes terem a possibilidade de não pagar, na data do vencimento, o valor total da fatura do cartão de crédito. Isto é, por causa do crédito rotativo, é possível que o cliente pague, no dia do vencimento, qualquer valor entre o pagamento mínimo e o total da fatura. A diferença entre o valor total que deveria ter sido pago e o valor que o cliente efetivamente pagou na data do vencimento é financiada pelo banco e será incluída, acrescida de juros, na fatura do mês seguinte. Quando o cliente não paga o total da fatura, é como se ele estivesse automaticamente pegando emprestado o valor que ele deixou de pagar.

Direito Creditório Descontado (Invoice Financing)

É o direito de receber dinheiro ou títulos, sejam eles oriundos de operações financeiras, comerciais, imobiliárias ou mesmo de ativos financeiros e investimentos. Esta opção abrange tanto pessoas físicas quanto entidades. Normalmente, ele “existe” na forma de um título.

Dependência (Branch)

Dependência de instituições financeiras e demais instituições, autorizadas a funcionar pelo Banco Central do Brasil, destinada à prática das atividades para as quais a instituição esteja regularmente habilitada. (Agência é a dependência destinada ao atendimento aos clientes e ao público em geral no exercício de atividades da instituição, não podendo ser móvel ou transitória)

Empréstimo (Loan)

É o mecanismo utilizado para ter disponível, no presente, uma quantia que só se conseguiria alcançar no futuro, fazendo poupança. O valor emprestado, mais os juros e encargos cobrados pela instituição financeira, vira uma dívida, que deverá ser paga na forma e no prazo combinados (valor e quantidade de parcelas, por exemplo). No empréstimo, o valor emprestado não tem destinação específica, isto é, a pessoa pode utilizar o dinheiro que pegou emprestado onde e como quiser.

Financiamento (Financing)

Parcelamento. Compra parcelada. Compra a prazo. É um crédito que a pessoa obtém para comprar um bem, como uma casa, um carro, um eletrodoméstico. O pagamento do bem é feito de forma parcelada por meio de carnês, boletos de cobrança, débitos em conta corrente, cartão de crédito, cheques etc. O financiamento pode incluir custos como juros, tarifas, impostos, entre outros encargos.

Indexador (Indexer)

É o termo utilizado para se referir aos índices usados como base para corrigir os valores monetários de um determinado ativo. Os índices mais utilizados são IPCA, INPC, IGP-M, CDI, Taxa Selic.

Instituição Financeira (Company)

Instituições que prestam serviços financeiros e são autorizadas a funcionar pelo Banco Central do Brasil.

Marca (Brand)

A marca é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.

Mês de referência (Reference Month)

O mês de referência será tratado como “M-1”.

Pacote de Serviços (Service Bundles)

Cesta de serviços. É uma combinação de diferentes quantidades de serviços bancários (saques, extratos, transferências, cheques e outros) que o cliente pode usar por mês. Antes da contratação de um pacote de serviços, é importante verificar quais os serviços que são efetivamente usados ao longo do mês e se o custo desses serviços, cobrados isoladamente, não é menor que o do pacote de serviços.

Posto de Atendimento Bancário - PAB (Branch)

São as dependências de bancos múltiplos com carteira comercial, instaladas em recinto interno de entidade da administração pública ou de empresa privada e destinadas a prestar todos os serviços para os quais a instituição esteja regularmente habilitada de exclusivo interesse do respectivo governo e de seus funcionários, quando instalados em entidade de administração pública, ou da respectiva empresa, de seus empregados e administradores, quando instalados em dependências de empresa privada.

Posto de Atendimento Eletrônico – PAE (Branch)

O Posto de Atendimento Bancário Eletrônico, Fixo ou Móvel (PAE), é uma extensão automatizada de dependências bancárias, que pode funcionar até 24 (vinte e quatro) horas por dia, ligada à central de controle e processamento.

Taxa Referencial – TR (Referential Rate)

É a taxa de juros de referência. É uma taxa calculada pelo Banco Central do Brasil e utilizada para determinar o rendimento de investimentos, como a caderneta de poupança e a correção de financiamentos imobiliários.

Terminais de Autoatendimento Compartilhados (Shared Automatic Teller Machine)

É o compartilhamento dos terminais de autoatendimento (ATM - dispositivo eletromecânico que permite aos usuários, geralmente usando cartões de plástico legíveis em máquina, a realização de um ou mais tipos de operações, tais como saques, depósitos, emissão de extratos e saldos, realização de pagamentos de contas e títulos, transferência de fundos e outro) para aumentar a eficiência do sistema de pagamento de varejo.

Unidade Administrativa Desmembrada (UAD) - (Branch)

É a dependência destinada à execução de atividades administrativas da instituição, tal como atividades contábeis e administrativas de natureza interna, desde que tal unidade esteja instalada no mesmo Município da sede do grupo financeiro, ou de uma agência da instituição e é vedado o atendimento ao público.

Segurança - Consumo

Visão geral

As APIs de Open Banking estão dividas em dois escopos:

Segue, um overview das camadas de segurança básicas para atender os contextos do Open-data:

Camada Descrição Explicação
Física Firewall Equipamentos e produtos como filtros, proxys e firewalls direcionados ao controle e segurança da rede física.
Transporte HTTP - TLS 1.2 Protocolo de criptografia que fornece segurança na comunicação sobre a rede física.
Gestão API Gateway / Manager Gateway e Manager para gerenciar a publicação da API com controles de throttling, quotas e outros.

CORS

Contexto Open-Data

O Cross-Origin Resource Sharing (CORS) para todas as origens (valor " * ") será permitido nos seguintes endpoints:

Endpoints

Contexto Open-data

Não haverá endpoints específicos para Autorização e Autenticação com o intuito de maximizar o uso do Open-data.

Será opcional a disponibilização de um endpoint para validação WKS:

api.banco.com.br/openbanking/security/v1/.well-known/jwks.json

Glossário de Segurança

Referências normativas

Referença Descrição Versão
[JSON] The JavaScript Object Notation (JSON) Data Interchange Format: https://tools.ietf.org/html/rfc8259 Dec 2017
[JWT] JSON Web Token (JWT): https://tools.ietf.org/html/rfc7519 May 2015
[JWS] JSON Web Signature (JWS): https://tools.ietf.org/html/rfc7797 Feb 2016

Referências informativas

Referença Descrição
[BCP195] Recomendações para o uso do seguro do Transport Layer Security (TLS) e Datagram Transport Layer Security (DTLS): https://tools.ietf.org/html/bcp195
[DOS-G] Guia de segurança sobre DDoS attacks: https://www.ncsc.gov.uk/collection/denial-service-dos-guidance-collection

Segurança - Participantes

Governança

Sobre

Esta área será oportunamente detalhada nas próximas fases do Open Banking.

Proteção

Sobre

Esta área será oportunamente detalhada nas próximas fases do Open Banking.

Detecção

Sobre

Esta área será oportunamente detalhada nas próximas fases do Open Banking.

Reação

Sobre

Esta área será oportunamente detalhada nas próximas fases do Open Banking.

Especificações de registro de participantes

Live do Cadastramento - acesse neste link o tutorial em vídeo.

Passo a passo do Cadastramento - acesse neste link o arquivo com instruções.

Problemas conhecidos da especificação

Atualmente não há problemas conhecidos.

Diretrizes de experiência do cliente

A ser publicada.

Diretrizes operacionais

A ser publicada.

Diretrizes técnicas do diretório

A ser publicada.

Calendário de versões das APIs

A ser publicado.

Guias de implementação

Acesse neste link uma implementação de referência da fase 1.

Esta implementação de exemplo permite ao desenvolvedor realizar testes referentes à fase 1 (open-data) do Open Banking Brasil.

Tempo de indisponibilidade das APIs

A ser publicado.

APIs comuns

API de status

Exemplo de código

GET https://api.banco.com.br/open-banking/discovery/v1/status HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/discovery/v1/status", true);
req.send();

O comando acima retorna uma estrutura json como exemplificada abaixo, e no caso em que o status devolvido seja OK, o array unavailableEndpoints deve estar vazio:

{
  "data": {
    "status": [
      {
        "code": "SCHEDULED_OUTAGE",
        "explanation": "Manutenção Planejada",
        "detectionTime": "2020-01-01T01:00:00Z",
        "expectedResolutionTime": "2020-01-01T01:00:00Z",
        "updateTime": "2020-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://api.banco.com.br/open-banking/channels/v1/branches"
        ]
      },
      {
        "code": "PARTIAL_FAILURE",
        "explanation": "Falha na execução do serviço",
        "detectionTime": "2020-01-01T01:00:00Z",
        "expectedResolutionTime": "2020-01-01T01:00:00Z",
        "updateTime": "2020-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://api.banco.com.br/open-banking/channels/v1/electronic-channels"
        ]
      }
    ],
    "links": {
      "self": "https://api.banco.com.br/open-banking/discovery/v1/status"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

GET /discovery/<versão>/status

Versão
1

Visão geral

Obtém a descrição referente ao código de status retornado pelas APIs.

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseDiscoveryStatusList

API de outages

Exemplo de código

GET https://api.banco.com.br/open-banking/discovery/v1/outages HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/discovery/v1/outages", true);
req.send();

Na estrutura de retorno exemplificada abaixo, no caso em que o parâmetro isPartial devolvido seja true, o array unavailableEndpoints deve conter a lista de endpoints indisponíveis:

{
  "data": {
    "outages": [
      {
        "outageTime": "2020-07-21T08:30:00Z",
        "duration": "PT2H30M",
        "isPartial": false,
        "explanation": "Atualização do API Gateway",
        "unavailableEndpoints": [
          "https://api.banco.com.br/open-banking/discovery/v1/outages"
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/discovery/v1/outages"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /discovery/<versão>/outages

Versão
1

Visão geral

Obtêm a lista de indisponibilidade agendada para os serviços.

Parâmetros

Nome Origem Tipo Obrigatório Descrição

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseDiscoveryOutagesList

Especificação em OAS 3.0

Download da Especificação (OAS 3.0)

API - Canais de atendimento

Dependências próprias

Exemplo de código

GET https://api.banco.com.br/open-banking/channels/v1/branches HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/channels/v1/branches", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "branches": [
            {
              "identification": {
                "type": "AGENCIA"
                "code": "0001",
                "checkDigit": "9",
                "name": "Marília",
                "relatedBranch": "0001",
                "openingDate": "2010-01-02"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki, 1270",
                "additionalInfo": "Loja B",
                "districtName": "Centro",
                "townName": "Marília",
                "ibgeCode": "3515890",
                "countrySubDivision": "SP",
                "postCode": "17500001",
                "country": "Brasil",
                "countryCode": "BRA",
                "geograficCoordinates": {
                  "latitude": "-90.009876543",
                  "longitude": "-180.00986543"
                }
              },
              "availability": {
                "standards": [
                  {
                    "weekday": "SEGUNDA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "TERCA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "QUARTA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "QUINTA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "SEXTA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  }
                ],
                "exception": "Exceto feriados municipais, estaduais e nacionais",
                "isPublicAccessAllowed": true
              },
              "phones": [
                {
                  "type": "FIXO",
                  "countryCallingCode": "55",
                  "areaCode": "14",
                  "number": "35721199"
                },
                {
                  "type": "MOVEL",
                  "countryCallingCode": "55",
                  "areaCode": "14",
                  "number": "997865532"
                }
              ],
              "services": [
                {
                  "name": "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA",
                  "code": "RECEBE_PAGA_QUALQUER_NATUREZA"
                },
                {
                  "name": "OUTROS_PRODUTOS_SERVICOS",
                  "code": "OUTROS_PRODUTOS_SERVICOS",
                  "additionalInfo": "Renegociação"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/channels/v1/branches",
    "first": "https://api.banco.com.br/open-banking/channels/v1/branches",
    "prev": "null",
    "next": "null",
    "last": "https://api.banco.com.br/open-banking/channels/v1/branches"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /channels/<versão>/branches

Versão
1

Visão geral

Obtém a lista de dependências próprias da instituição financeira.

Dependência própria é o espaço físico destinado ao atendimento ao público.

Tags: Agência (Branch), CNPJ (CNPJ Number), Marca (Brand), Dependência (Branch), Instituição Financeira (Company), Posto de Atendimento Bancário - PAB (Branch), Posto de Atendimento Eletrônico – PAE (Branch) e Unidade Administrativa Desmembrada – UAD (Branch).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBranchesList

Canais de atendimento eletrônico

Exemplo de código

GET https://api.banco.com.br/open-banking/channels/v1/electronic-channels HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/channels/v1/electronic-channels", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "electronicChannels": [
            {
              "identification": {
                "type": "INTERNET_BANKING",
                "urls": [
                  "https://empresaa1.com/internet-banking"
                ]
              },
              "services": [
                {
                  "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
                  "code": "ABRE_CONTA_DEPOSITO_OU_PRE_PAGA"
                },
                {
                  "name": "CARTAO_CREDITO",
                  "code": "CARTAO_CREDITO"
                }
              ]
            },
            {
              "identification": {
                "type": "MOBILE_BANKING",
                "urls": [
                  "https://empresaa1.com/mobile-zeta",
                  "https://empresaa1.com/mobile-aaa",
                  "https://empresaa1.com/mobile-bbb"
                ]
              },
              "services": [
                {
                  "name": "CARTAO_CREDITO",
                  "code": "CARTAO_CREDITO"
                },
                {
                  "name": "OPERACOES_ARRENDAMENTO_MERCANTIL",
                  "code": "OPERA_ARRENDAMENTO_MERCANTIL"
                },
                {
                  "name": "OUTROS_PRODUTOS_SERVICOS",
                  "code": "OUTROS_PRODUTOS_SERVICOS",
                  "additionalInfo": "Atendimento em outros idiomas"
                }

              ]
            },
            {
              "identification": {
                "type": "CHAT",
                "urls": [
                  "https://empresaa1.com/channels-chat1",
                  "https://empresaa1.com/channels-chat2"
                ]
              },
              "services": [
                {
                  "name": "SEGUROS",
                  "code": "SEGUROS"
                },
                {
                  "name": "APLICACOES_RESGATES_INVESTIMENTOS",
                  "code": "APLICA_RESGATA_INVESTIMENTOS"
                },
                {
                  "name": "EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGAMENTO_SOLICITACAO_CLIENTES_USUARIOS",
                  "code": "EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGTO"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/channels/v1/electronic-channels",
    "first": "https://api.banco.com.br/open-banking/channels/v1/electronic-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.banco.com.br/open-banking/channels/v1/electronic-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /channels/<versão>/electronic-channels

Versão
1

Visão geral

Obtém a lista de canais eletrônicos próprios da instituição financeira.

Esse endpoint retorna os possíveis canais de atendimento eletrônico, bem como suas informações, serviços prestados e formas de acesso.

Tags: CNPJ (CNPJ Number), Marca (Brand) e Instituição Financeira (Company).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseElectronicChannelsList

Canais de atendimento telefônico

Exemplo de código

GET https://api.banco.com.br/open-banking/channels/v1/phone-channels HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/channels/v1/phone-channels", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "phoneChannels": [
            {
              "identification": {
                "type": "CENTRAL_TELEFONICA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "35721199",
                    "additionalInfo": "NA"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "997865532",
                    "additionalInfo": "NA"
                  }
                ]
              },
              "services": [
                {
                  "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
                  "code": "ABRE_CONTA_DEPOSITO_OU_PRE_PAGA"
                },
                {
                  "name": "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA",
                  "code": "RECEBE_PAGA_QUALQUER_NATUREZA"
                },
                {
                  "name": "OUTROS_PRODUTOS_SERVICOS",
                  "code": "OUTROS_PRODUTOS_SERVICOS",
                  "additionalInfo": "Atendimento em outros idiomas"
                }
              ]
            },
            {
              "identification": {
                "type": "SAC",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI ' ', DDD ' ', 40044828, 'Para regiões metropolitanas'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI ' ', DDD ' ', 40044828, 'Para demais localidades'"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACOES",
                  "code": "RECLAMACOES"
                },
                {
                  "name": "INFORMACOES",
                  "code": "INFORMACOES"
                },
                {
                  "name": "CANCELAMENTO",
                  "code": "CANCELAMENTO"
                }
              ]
            },
            {
              "identification": {
                "type": "OUVIDORIA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555",
                    "additionalInfo": "DDI '55'; DDD '11', 40045555, 'Para clientes no exterior'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555",
                    "additionalInfo": "DDI ' ', DDD ' ', 40045555, 'Para regiões metropolitanas'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555",
                    "additionalInfo": "DDI ' ', DDD ' ', 40045555, 'Para demais localidades'"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACOES",
                  "code": "RECLAMACOES"
                },
                {
                  "name": "INFORMACOES",
                  "code": "INFORMACOES"
                }
              ]
            },
            {
              "identification": {
                "type": "OUTROS",
                "additionalInfo": "Receptivo",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "NA",
                    "number": "40043277",
                    "additionalInfo": "DDI ' ', DDD ' ', 40043277', 'Para regiões metropolitanas'"
                  },
                  {
                    "countryCallingCode": "NA",
                    "areaCode": "NA",
                    "number": "40043277",
                    "additionalInfo": "DDI ' ', DDD ' ', 40043277', 'Para demais localidades'"
                  }
                ]
              },
              "services": [
                {
                  "name": "OUTROS_PRODUTOS_SERVICOS",
                  "code": "OUTROS_PRODUTOS_SERVICOS",
                  "additionalInfo": "Previdência Privada"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/channels/v1/phone-channels",
    "first": "https://api.banco.com.br/open-banking/channels/v1/phone-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.banco.com.br/open-banking/channels/v1/phone-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /channels/<versão>/phone-channels

Versão
1

Visão geral

Obtém a lista de canais telefônicos próprios da instituição financeira.

Esse endpoint retorna os possíveis canais de atendimento telefônico bem como suas informações, serviços prestados e formas de acesso.

Tags: CNPJ (CNPJ Number), Marca (Brand) e Instituição Financeira (Company).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePhoneChannelsList

Correspondentes bancários

Exemplo de código:

GET https://api.banco.com.br/open-banking/channels/v1/banking-agents HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/channels/v1/banking-agents", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "contractors": [
            {
              "name": "Empresa Contratante 1",
              "cnpjNumber": "99558332000137",
              "bankingAgents": [
                {
                  "identification": {
                    "corporationName": "Empresa Correspondente A",
                    "groupName": "Grupo Master",
                    "cnpjNumber": "02345876000299",
                    "isUnderestablishment": true
                  },
                  "locations": [
                    {
                      "postalAddress": {
                        "address": "Av Tasuko Ykeda, 25",
                        "districtName": "Centro",
                        "townName": "Marília",
                        "countrySubDivision": "SP",
                        "postCode": "17500001",
                        "additionalInfo": "Loja B.",
                        "ibgeCode": "3550308",
                        "country": "Brasil",
                        "countryCode": "BRA",
                        "geographicCoordinates": {
                          "latitude": "-90.8365180",
                          "longitude": "-180.836519"
                        }
                      },
                      "phones": [
                        {
                          "type": "FIXO",
                          "countryCallingCode": "55",
                          "areaCode": "14",
                          "number": "35721199"
                        },
                        {
                          "type": "MOVEL",
                          "countryCallingCode": "55",
                          "areaCode": "14",
                          "number": "997865532"
                        }
                      ],
                      "availability": {
                        "standards": [
                          {
                            "weekday": "SEGUNDA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "TERCA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "QUARTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "QUINTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "SEXTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          }
                        ],
                        "exception": "Exceto feriados municipais, estaduais e nacionais",
                        "isPublicAccessAllowed": true
                      }
                    },
                    {
                      "postalAddress": {
                        "address": "R Yroshima Takasi, 72",
                        "districtName": "Altos da Colina",
                        "townName": "Marília",
                        "countrySubDivision": "SP",
                        "postCode": "17526760",
                        "additionalInfo": "Loja 2.",
                        "ibgeCode": "3550308",
                        "country": "Brasil",
                        "countryCode": "BRA",
                        "geographicCoordinates": {
                          "latitude": "-90.8365180",
                          "longitude": "-180.836519"
                        }
                      },
                      "phones": [
                        {
                          "type": "FIXO",
                          "countryCallingCode": "55",
                          "areaCode": "14",
                          "number": "64721199"
                        }
                      ],
                      "availability": {
                        "standards": [
                          {
                            "weekday": "SEGUNDA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "TERCA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "QUARTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "QUINTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "SEXTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          }
                        ],
                        "exception": "Exceto feriados municipais, estaduais e nacionais",
                        "isPublicAccessAllowed": true
                      }
                    },
                    {
                      "postalAddress": {
                        "address": "Al Nasso Origami, 15, bloco A",
                        "districtName": "Centro",
                        "townName": "Marília",
                        "countrySubDivision": "SP",
                        "postCode": "17500-001",
                        "additionalInfo": "Loja B.",
                        "ibgeCode": "3550308",
                        "country": "Brasil",
                        "countryCode": "BRA",
                        "latitude": "-90.8365180",
                        "longitude": "-180.836519"
                      },
                      "availability": {
                        "standards": [
                          {
                            "weekday": "SEGUNDA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "TERCA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "QUARTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "QUINTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          },
                          {
                            "weekday": "SEXTA_FEIRA",
                            "openingTime": "10:00:57Z",
                            "closingTime": "16:00:57Z"
                          }
                        ],
                        "exception": "Exceto feriados municipais, estaduais e nacionais",
                        "isPublicAccessAllowed": true
                      }
                    }
                  ],
                  "services": [
                    {
                      "name": "RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_ABERTURA_CONTAS_DEPOSITOS_VISTA_PRAZO_POUPANCA_MANTIDOS_INSTITUICAO_CONTRATANTE",
                      "code": "RECEBE_ENCAMINHA_PROPOSTAS_ABERTURA_CONTAS"
                    },
                    {
                      "name": "REALIZACAO_RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS_VISANDO_MOVIMENTACAO_CONTAS_DEPOSITOS_TITULARIDADE_CLIENTES_MANTIDAS_INSTITUICAO_CONTRATANTE",
                      "code": "REALIZA_RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS"
                    },
                    {
                      "name": "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA_OUTRAS_ATIVIDADES_DECORRENTES_EXECUCAO_CONTRATOS_CONVENIOS_PRESTACAO_SERVICOS",
                      "code": "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA_EXECUCAO_CONTRATOS_CONVENIO"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/channels/v1/banking-agents",
    "first": "https://api.banco.com.br/open-banking/channels/v1/banking-agents",
    "prev": "null",
    "next": "null",
    "last": "https://api.banco.com.br/open-banking/channels/v1/banking-agents"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /channels/<versão>/banking-agents

Versão
1

Visão geral

Obtém a lista de Correspondentes bancários.

Tags: Correspondente bancário (Banking Agent), CNPJ (CNPJ Number), Marca (Brand) e Instituição Financeira (Company).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBankingAgentsList

Terminais de autoatendimento compartilhados

Exemplo de código:

GET https://api.banco.com.br/open-banking/channels/v1/shared-automated-teller-machines HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/channels/v1/shared-automated-teller-machines", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresadaorganizacaoa.com/complementarylist",
          "sharedAutomatedTellerMachines": [
            {
              "identification": {
                "ownerName": "João da Silva Santos"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki, 1270",
                "additionalInfo": "Fundos",
                "districtName": "Centro",
                "townName": "Marília",
                "ibgeCode": "3515890"
                "countrySubDivision": "SP",
                "postCode": "17500001",
                "country": "Brasil",
                "countryCode": "BRA",
                "geographicCoordinates": {
                   "latitude": "-90.8365180",
                   "longitude": "-180.836519"
                 }
              },
              "availability": {
                "standards": [
                  {
                    "weekday": "SEGUNDA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "TERCA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "QUARTA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "QUINTA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  },
                  {
                    "weekday": "SEXTA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  }
                ],
                "exception": "Exceto feriados municipais, nacionais e estaduais",
                "isPublicAccessAllowed": true
              },
              "services": [
                {
                  "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
                  "code": "ABRE_CONTA_DEPOSITO_OU_PRE_PAGA"
                },
                {
                  "name": "SAQUE_MOEDA_EM_ESPECIE",
                  "code": "SAQUE_MOEDA_ESPECIE"
                },
                {
                  "name": "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA",
                  "code": "RECEBE_PAGA_QUALQUER_NATUREZA"
                },
                {
                  "name": "TRANSFERENCIAS_ELETRONICAS_VISANDO_MOVIMENTACAO",
                  "code": "TRANSFERENCIAS_ELETRONICAS_MOVIMENTA_CONTAS_DEPOSITOS_OU_PAGA_TITULARES_CLIENTES"
                },
                {
                  "name": "CONSULTA_SALDOS_EXTRATOS_CONTAS_DEPOSITOS_E_CONTAS",
                  "code": "CONSULTA_SALDOS_EXTRATOS_CONTAS_DEPOSITOS"
                },
                {
                  "name": "APLICACOES_RESGATES_INVESTIMENTOS",
                  "code": "APLICA_RESGATA_INVESTIMENTOS"
                },
                {
                  "name": "CARTAO_CREDITO",
                  "code": "CARTAO_CREDITO"
                },
                {
                  "name": "SEGUROS",
                  "code": "SEGUROS"
                },
                {
                  "name": "OPERACOES_ARRENDAMENTO_MERCANTIL",
                  "code": "OPERACOES_ARRENDAMENTO_MERCANTIL"
                },
                {
                  "name": "OUTROS_PRODUTOS_SERVICOS",
                  "code": "OUTROS_PRODUTOS_SERVICOS",
                  "additionalInfo": "Serviços complementares de atendimento via terminais de autoatendimento."
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/channels/v1/shared-automated-teller-machines",
    "first": "https://api.banco.com.br/open-banking/channels/v1/shared-automated-teller-machines",
    "prev": "null",
    "next": "null",
    "last": "https://api.banco.com.br/open-banking/channels/v1/shared-automated-teller-machines"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /channels/<versão>/shared-automated-teller-machines

Versão
1

Visão geral

Obtém a lista de terminais compartilhados de autoatendimento da instituição financeira.

Tags: CNPJ (CNPJ Number), Marca (Brand), Instituição Financeira (Company), Terminais de Autoatendimento Compartilhados (Shared Automatic Teller Machine).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseSharedAutomatedTellerMachinesList

Especificação em OAS 3.0

Download da Especificação (OAS 3.0)

API - Produtos e serviços

Contas pessoa natural

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/personal-accounts HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/personal-accounts", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "personalAccounts": [
            {
              "type": "CONTA_DEPOSITO_A_VISTA",
              "fees": {
                "priorityServices": [
                  {
                    "name": "TRANSFERENCIA_TED_PESSOAL_OU_PRESENCIAL",
                    "code": "TED_PESSOAL",
                    "chargingTriggerInfo": "Realização de transferência de recursos por meio de Transferência Eletrônica Disponível (TED) em guichê de caixa ou mediante outras formas de atendimento pessoal, incluindo o atendimento telefônico realizado por atendente",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "35.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "45.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "52.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "19.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "88.00",
                      "currency": "BRL"
                    }
                  },
                  {
                    "name": "FORNECIMENTO_2_VIA_CARTAO_FUNCAO_DEBITO",
                    "code": "2_VIA_CARTAO_DEBITO",
                    "chargingTriggerInfo": "Confecção e emissão de novo cartão com função débito, restrito a casos de pedidos de reposição formulados pelo detentor da conta, decorrente de perda, roubo, furto, danificação e outros motivos não imputáveis à instituição emitente",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "37.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "45.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "52.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "35.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "72.00",
                      "currency": "BRL"
                    }
                  }
                ],
                "otherServices": [
                  {
                    "name": "Entrega de talão de cheque em domícilio",
                    "code": "'TALAO_DOMICILIO",
                    "chargingTriggerInfo": "Por remessa",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "30.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "45.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "62.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "19.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "88.00",
                      "currency": "BRL"
                    }
                  },
                  {
                    "name": "2ª via de recibo de transação eletrônica",
                    "code": "'SEGUNDA_RECIBO_TE",
                    "chargingTriggerInfo": "Por documento",
                    "prices": [
                      {
                        "interval": "1_FAIXA_VALOR",
                        "value": "37.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA_VALOR",
                        "value": "45.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA_VALOR",
                        "value": "62.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA_VALOR",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "15.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "72.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "serviceBundles": [
                {
                  "name": "Conta de depósitos à vista Movimentação com cartão (sem cheque)",
                  "services": [
                    {
                      "code": "CADASTRO",
                      "chargingTriggerInfo": "Realização de pesquisa em serviços de proteção ao crédito, base de dados e informações cadastrais, e tratamento de dados e informações necessários ao início relacionamento decorrente da abertura de conta de depósitos à vista ou de poupança ou contratação de operação de crédito ou de arrendamento mercantil, não podendo ser cobrada cumulativamente",
                      "eventLimitQuantity": "1",
                      "freeEventQuantity": "0"
                    },
                    {
                      "code": "SAQUE_TERMINAL",
                      "chargingTriggerInfo": "Saque em terminal de autoatendimento além do número de saques permitidos gratuitamente por mês. Nas 'contas eletrônicas' não pode ser cobrada tarifa para este canal de entrega",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "8"
                    },
                    {
                      "code": "CHEQUE_VISADO",
                      "chargingTriggerInfo": "Procedimentos para registro e bloqueio do saldo em conta de depósitos à vista",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "4"
                    },
                    {
                      "code": "CHEQUE_ADMINISTRATIVO",
                      "chargingTriggerInfo": "Emissão de cheque administrativo",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "2"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "1_FAIXA",
                      "monthlyFee": "43.40",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "monthlyFee": "55.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "monthlyFee": "62.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "monthlyFee": "69.0",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimum": {
                    "value": "19.00",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "88.00",
                    "currency": "BRL"
                  }
                },
                {
                  "name": "Conta de depósitos à vista -Pacote XXX",
                  "services": [
                    {
                      "code": "Serviço 1",
                      "chargingTriggerInfo": "Realização de pesquisa em serviços de proteção ao crédito, base de dados e informações cadastrais, e tratamento de dados e informações necessários ao início relacionamento decorrente da abertura de conta de depósitos à vista ou de poupança ou contratação de operação de crédito ou de arrendamento mercantil, não podendo ser cobrada cumulativamente",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "999999"
                    },
                    {
                      "code": "Serviço 2",
                      "chargingTriggerInfo": "Saque em terminal de autoatendimento além do número de saques permitidos gratuitamente por mês. Nas 'contas eletrônicas' não pode ser cobrada tarifa para este canal de entrega",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "8"
                    },
                    {
                      "code": "Serviço 3",
                      "chargingTriggerInfo": "Procedimentos para registro e bloqueio do saldo em conta de depósitos à vista",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "4"
                    },
                    {
                      "code": "Serviço 4",
                      "chargingTriggerInfo": "Emissão de cheque administrativo",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "2"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "1_FAIXA_VALOR",
                      "monthlyFee": "30.40",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA_VALOR",
                      "monthlyFee": "45.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA_VALOR",
                      "monthlyFee": "62.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA_VALOR",
                      "monthlyFee": "69.0",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimum": {
                    "value": "25.00",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "72.00",
                    "currency": "BRL"
                  }
                }
              ],
              "openingClosingChannels": [
                "DEPENDENCIAS_PROPRIAS",
                "CORRESPONDENTES_BANCARIOS",
                "INTERNET_BANKING",
                "MOBILE_BANKING",
                "CENTRAL_TELEFONICA",
                "CHAT",
                "OUTROS"
              ],
              "additionalInfo": "WhatsApp",
              "transactionMethods": [
                "MOVIMENTACAO_CARTAO"
              ],
              "termsConditions": {
                "minimumBalance": {
                  "value": "200.00",
                  "currency": "BRL"
                },
                "elegibilityCriteriaInfo": "https://empresaa1.com/Accounts_closingProcess",
                "closingProcessInfo": "https://empresaa1.com/Accounts_closingProcess"
              },
              "incomeRate": [
                {
                  "savingAccount": "NA",
                  "prepaidPaymentAccount": "NA"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/personal-accounts",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/personal-accounts",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/personal-accounts"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/personal-accounts

Versão
1

Visão geral

Obtém os dados da Conta pessoa natural.

Esta especificação inclui todos os artefatos relevantes para a Especificação de API sobre Contas de depósito à vista, poupança e de pagamento pré-paga pessoa natural de dados abertos.

Tags: Marca (Brand), CNPJ (CNPJ Number), Conta de depósito à vista (Account), Conta de pagamento pré-paga (Prepaid Payment Account), Conta de Poupança (Saving Account), Instituição Financeira (Company), Pacote de Serviços (Service Bundles), Taxa Referencial – TR (Referential Rate) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePersonalAccounts

Contas pessoa jurídica

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/business-accounts HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/business-accounts", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "businessAccounts": [
            {
              "type": "CONTA_DEPOSITO_A_VISTA",
              "fees": {
                "services": [
                  {
                    "name": "Entrega de talão de cheque em domícilio",
                    "code": "TALAO_DOMICILIO",
                    "chargingTriggerInfo": "Por remessa",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "55.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "65.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "72.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "49.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "88.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "serviceBundles": [
                {
                  "name": "Conta de depósitos à vista Movimentação com cartão (sem cheque)",
                  "services": [
                    {
                      "code": "CADASTRO",
                      "chargingTriggerInfo": "Realização de pesquisa em serviços de proteção ao crédito, base de dados e informações cadastrais, e tratamento de dados e informações necessários ao início relacionamento decorrente da abertura de conta de depósitos à vista ou de poupança ou contratação de operação de crédito ou de arrendamento mercantil, não podendo ser cobrada cumulativamente",
                      "eventLimitQuantity": "1",
                      "freeEventQuantity": "0"
                    },
                    {
                      "code": "SAQUE_TERMINAL",
                      "chargingTriggerInfo": "Saque em terminal de autoatendimento além do número de saques permitidos gratuitamente por mês. Nas 'contas eletrônicas' não pode ser cobrada tarifa para este canal de entrega",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "8"
                    },
                    {
                      "code": "CHEQUE_VISADO",
                      "chargingTriggerInfo": "Procedimentos para registro e bloqueio do saldo em conta de depósitos à vista correspondente ao valor do cheque",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "4"
                    },
                    {
                      "code": "CHEQUE_ADMINISTRATIVO",
                      "chargingTriggerInfo": "Emissão de cheque administrativo",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "2"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "1_FAIXA",
                      "monthlyFee": "50.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "monthlyFee": "65.40",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "monthlyFee": "75.40",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "monthlyFee": "83.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimum": {
                    "value": "45.00",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "87.00",
                    "currency": "BRL"
                  }
                }
              ],
              "openingClosingChannels": [
                "DEPENDENCIAS_PROPRIAS",
                "CORRESPONDENTES_BANCARIOS",
                "INTERNET_BANKING",
                "MOBILE_BANKING",
                "CENTRAL_TELEFONICA",
                "CHAT",
                "OUTROS"
              ],
              "additionalInfo": "WhastApp",
              "transactionMethods": [
                "MOVIMENTACAO_CARTAO"
              ],
              "termsConditions": {
                "minimumBalance": {
                  "value": "500.00",
                  "currency": "BRL"
                },
                "elegibilityCriteriaInfo": "https://empresaa1.com/Accounts_elegebilityCriteria",
                "closingProcessInfo": "https://empresaa1.com/Accounts_closingProcess"
              },
              "incomeRate": {
                "savingAccount": "NA",
                "prepaidPaymentAccount": "NA"
              }
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/business-accounts",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/business-accounts",
    "prev": "",
    "next": "",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/business-accounts"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/business-accounts

Versão
1

Visão geral

Obtém os dados da Conta pessoa jurídica.

Esta especificação inclui todos os artefatos relevantes para a Especificação de API sobre Contas de depósito à vista, poupança e de pagamento pré-paga para pessoa jurídica de dados abertos.

Tags: Marca (Brand), CNPJ (CNPJ Number), Conta de depósito à vista (Account), Conta de pagamento pré-paga (Prepaid Payment Account), Conta de Poupança (Saving Account), Instituição Financeira (Company), Pacote de Serviços (Service Bundles), Taxa Referencial – TR (Referential Rate) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBusinessAccounts

Empréstimos pessoa natural

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/personal-loans HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/personal-loans", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "cnpjNumber": "45086338000178",
          "name": "Empresa A1",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "personalLoans": [
            {
              "type": "EMPRESTIMO_CREDITO_PESSOAL_CONSIGNADO",
              "fees": {
                "services": [
                  {
                    "name": "Crédito pessoal consignado",
                    "code": "NA",
                    "chargingTriggerInfo": "Tarifa cobrada sobre demanda",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "860.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "1090.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "2100.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "430.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "2200.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.15",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0187"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2900"
                      },
                      "customers": {
                         "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                         "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7990"
                      },
                      "customers": {
                         "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0056",
                  "maximumRate": "0.8565"
                }
              ],
              "requiredWarranties": [
                "NAO_APLICAVEL"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CREDITO_PESSOAL_SEM_CONSIGNACAO",
              "fees": {
                "services": [
                  {
                    "name": "Crédito pessoal sem consignação",
                    "code": "NA",
                    "chargingTriggerInfo": "1% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "3500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "4200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4900.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "5006.00",
                        "currency": "BRL",
                        "customers": {
                           "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "2290.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "5800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.1500"
                      },
                      "customers": {
                          "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2000"
                      },
                      "customers": {
                         "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3500"
                      },
                      "customers": {
                          "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.6800"
                      },
                      "customers": {
                          "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.1450",
                  "maximumRate": "0.6900"
                }
              ],
              "requiredWarranties": [
                "HIPOTECA"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_HOME_EQUITY",
              "fees": {
                "services": [
                  {
                    "name": "Avaliação, Reavaliação e Substituição de Bens Recebidos em Garantia para Empréstimos com Garantia de Imóvel",
                    "code": "NA",
                    "chargingTriggerInfo": "2% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7006.00",
                        "currency": "BRL"
                        "customers": {
                            "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1350.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.13",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                          "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                          "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                          "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                          "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "ALIENACAO_FIDUCIARIA",
                "HIPOTECA"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO",
              "fees": {
                "services": [
                  {
                    "name": "Taxa de Abertura de Crédito - Microcrédito Produtivo Orientado",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                        {
                          "interval": "1_FAIXA",
                          "value": "1000.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.1500"
                          }
                        },
                        {
                          "interval": "2_FAIXA",
                          "value": "1200.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.3500"
                          }
                        },
                        {
                          "interval": "3_FAIXA",
                          "value": "3072.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.2000"
                          }
                        },
                        {
                          "interval": "4_FAIXA",
                          "value": "7020.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.3000"
                          }
                        }
                    ],
                    "minimum": {
                        "value": "560.00",
                        "currency": "BRL"
                    },
                    "maximum": {
                        "value": "8000.00",
                        "currency": "BRL"
                    }
                  },
                  {
                    "name": "Microcrédito Pessoa Natural",
                    "code": "NA",
                    "chargingTriggerInfo": "2% do valor do contrato",
                    "prices": [
                        {
                          "interval": "1_FAIXA",
                          "value": "2000.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.1500"
                          }
                        },
                        {
                          "interval": "2_FAIXA",
                          "value": "3200.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.3500"
                          }
                        },
                        {
                          "interval": "3_FAIXA",
                          "value": "5072.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.2000"
                          }
                        },
                        {
                          "interval": "4_FAIXA",
                          "value": "3006.00",
                          "currency": "BRL",
                          "customers": {
                              "rate": "0.3000"
                          }
                        }
                    ],
                    "minimum": {
                        "value": "1890.00",
                        "currency": "BRL"
                    },
                    "maximum": {
                        "value": "5800.00",
                        "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                          "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                          "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                          "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7680"
                      },
                      "customers": {
                          "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.8100"
                }
              ],
              "requiredWarranties": [
                "OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CHEQUE_ESPECIAL",
              "fees": {
                "services": [
                  {
                    "name": "Adiantamento a Depositantes / Excesso Limite",
                    "code": "NA",
                    "chargingTriggerInfo": "0,25% sobre o excedente do limite acima de R$500,00",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "1700.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "2200.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4030.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "5030.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "770.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "5800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.20",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                          "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                          "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                          "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                          "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "GARANTIA_FIDEJUSSORIA"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CONTA_GARANTIDA",
              "fees": {
                "services": [
                  {
                    "name": "Descoberto em C/C, Conta garantida",
                    "code": "NA",
                    "chargingTriggerInfo": "Tarifa R$63,00",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "345.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "479.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "776.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "1300.00",
                        "currency": "BRL",
                        "customers": {
                            "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "110.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "1390.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.18",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                          "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                          "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                          "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7680"
                      },
                      "customers": {
                          "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.8100"
                }
              ],
              "requiredWarranties": [
                "GARANTIA_FIDEJUSSORIA"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/personal-loans

Versão
1

Visão geral

Obtém os dados de Empréstimos para pessoa natural.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Empréstimos para pessoa natural de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Crédito Rotativo (Overdraft), Empréstimo (Loan), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePersonalLoans

Empréstimos pessoa jurídica

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/business-loans HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/business-loans", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "cnpjNumber": "45086338000178",
          "name": "Empresa A1",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "businessLoans": [
            {
              "type": "EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO",
              "fees": {
                "services": [
                  {
                    "name": "Taxa de Abertura de Crédito - Microcrédito Produtivo Orientado",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1350.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateOrIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.15",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CHEQUE_ESPECIAL",
              "fees": {
                "services": [
                  {
                    "name": "Cheque Especial",
                    "code": "NA",
                    "chargingTriggerInfo": "0,25% sobre o excente do limite acima de R$500,00",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "6006.00",
                        "currency": "BRL",
                        "customers": {
                           "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1300.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "6800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateOrIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7680"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "GARANTIA_FIDEJUSSORIA"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CONTA_GARANTIDA",
              "fees": {
                "services": [
                  {
                    "name": "Descoberto em C/C, Conta garantida",
                    "code": "NA",
                    "chargingTriggerInfo": "Tarifa R$63,00",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "1500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3800.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4090.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7786.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "830.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateOrIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7680"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "GARANTIA_FIDEJUSSORIA"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CAPITAL_GIRO_PRAZO_VENCIMENTO_ATE_365_DIAS",
              "fees": {
                "services": [
                  {
                    "name": "Contratação",
                    "code": "NA",
                    "chargingTriggerInfo": "(mín. R$ 100,00 máx. R$ 3.000), tarifa 3% do Contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "1700.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "2200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4030.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "5030.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "770.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "5800.00",
                      "currency": "BRL"
                    }
                  },
                  {
                    "name": "Alteração Contratual",
                    "code": "NA",
                    "chargingTriggerInfo": "(mín. R$ 100,00 máx. R$ 3.000), tarifa 3% do Contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "55.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "62.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "75.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "86.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "49.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "90.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateOrIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.15",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0150"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2240"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3090"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.6223"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0100",
                  "maximumRate": "0.7100"
                }
              ],
              "requiredWarranties": [
                "NAO_APLICAVEL"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CAPITAL_GIRO_PRAZO_VENCIMENTO_SUPERIOR_365_DIAS",
              "fees": {
                "service": {
                  "name": "Amortização/Liquidação antecipada",
                  "code": "NA",
                  "chargingTriggerInfo": "2 % do Contrato",
                  "prices": [
                    {
                      "interval": "1_FAIXA",
                      "value": "345.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "value": "479.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "value": "776.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "value": "1300.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimum": {
                    "value": "110.00",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "1390.00",
                    "currency": "BRL"
                  }
                }
              },
              "interestRates": [
                {
                  "referentialRateOrIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.09",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "NAO_APLICAVEL"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            },

            {
              "type": "EMPRESTIMO_CAPITAL_GIRO_ROTATIVO",
              "fees": {
                "services": [
                  {
                    "name": "Renovação",
                    "code": "NA",
                    "chargingTriggerInfo": "(mín. R$ 100 máx. R$ 1.100,00), tarifa 3% do Contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "1000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3800.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7826.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "610.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8580.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateOrIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.18",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7680"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.8100"
                }
              ],
              "requiredWarranties": [
                "NAO_APLICAVEL"
              ],
              "termsConditions": "https://empresaa1.com/personal_loans"
            }

          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/business-loans

Versão
1

Visão geral

Obtém os dados de Empréstimos para pessoa jurídica.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Empréstimos para pessoa jurídica de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Crédito Rotativo (Overdraft), Empréstimo (Loan), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBusinessLoans

Financiamento pessoa natural

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/personal-financings HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/personal-financings", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "cnpjNumber": "50685362000135",
          "name": "Empresa A1",
          "urlComplementaryList": "https://empresadaorganizacaoa.com/complementarylist",
          "personalFinancings": [
            {
              "type": "FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES",
              "fees": {
                "services": [
                  {
                    "name": "Avaliação, Reavaliação e Substituição de Bens Recebidos em Garantia",
                    "code": "AQBAM009",
                    "chargingTriggerInfo": "R$ 570.00 Por solicitação",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "45.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "57.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "62.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "39.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "71.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "PRE_FIXADO",
                  "rate": "0.15"
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "ALIENACAO_FIDUCIARIA",
                "PENHOR"
              ],
              "termsConditions": "https://empresaa1.com/personal_financing"
            },
            {
              "type": "FINANCIAMENTO_AQUISICAO_BENS_OUTROS_BENS",
              "fees": {
                "services": [
                  {
                    "name": "tarifa para abertura de credito",
                    "code": "tarifa para abertura de credito",
                    "chargingTriggerInfo": "R$ 570.00 Por solicitação",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "860.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "1090.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "2100.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "430.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "2200.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10"
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0187"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2900"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7990"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0056",
                  "maximumRate": "0.8565"
                }
              ],
              "requiredWarranties": [
                "ALIENACAO_FIDUCIARIA",
                "PENHOR"
              ],
              "termsConditions": "https://empresaa1.com/personal_financing"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/personal-financings

Versão
1

Visão geral

Obtém os dados de Financiamento para pessoa natural.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Financiamentos para pessoa natural de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Financiamento (Financing), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePersonalFinancings

Financiamento pessoa jurídica

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/business-financings HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/business-financings", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "cnpjNumber": "45086338000178",
          "name": "Empresa A1",
          "urlComplementaryList": "https://empresadaorganizacaoa.com/complementarylist",
          "businessFinancings": [
            {
              "type": "FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES",
              "fees": {
                "services": [
                  {
                    "name": "Avaliação, Reavaliação e Substituição de Bens Recebidos em Garantia",
                    "code": "AQBAM009",
                    "chargingTriggerInfo": "R$ 570.00 Por solicitação",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "1000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "1200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "3072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7020.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1350.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.15"
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "ALIENACAO_FIDUCIARIA"
              ],
              "termsConditions": "https://empresaa1.com/personal_financing"
            },
            {
              "type": "FINANCIAMENTO_AQUISICAO_BENS_OUTROS_BENS",
              "fees": {
                "services": [
                  {
                    "name": "Avaliação do Bem",
                    "code": "NA",
                    "chargingTriggerInfo": "1% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "6006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1890.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "5800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10"
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0187"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2900"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7990"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0056",
                  "maximumRate": "0.8565"
                }
              ],
              "requiredWarranties": [
                "ALIENACAO_FIDUCIARIA"
              ],
              "termsConditions": "https://empresaa1.com/personal_financing"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/business-financings

Versão
1

Visão geral

Obtém os dados de Financiamento para pessoa jurídica.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Financiamentos para pessoa jurídica de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Financiamento (Financing), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBusinessFinancings

Antecipação de recebíveis pessoa natural

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/personal-invoice-financings HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/personal-invoice-financings", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "personalInvoiceFinancings": [
            {
              "type": "DESCONTO_DUPLICATAS",
              "fees": {
                "services": [
                  {
                    "name": "Custódia de Duplicatas",
                    "code": "NA",
                    "chargingTriggerInfo": "5% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "25.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "35.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "52.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "15.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "87.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.15",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "CESSAO_DIREITOS_CREDITORIOS"
              ],
              "termsConditions": "https://empresaa1.com/personal_invoice_financings"
            },

            {
              "type": "DESCONTO_CHEQUES",
              "fees": {
                "services": [
                  {
                    "name": "Custódia de Cheques pré-datados: Inclusão",
                    "code": "NA",
                    "chargingTriggerInfo": "R$ 0,80",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "345.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "479.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "776.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "1300.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "110.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "1390.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "CAUCAO"
              ],
              "termsConditions": "https://empresaa1.com/personal_invoice_financings"
            },

            {
              "type": "ANTECIPACAO_FATURA_CARTAO_CREDITO",
              "fees": {
                "services": [
                  {
                    "name": "Aditamento de recebiveis",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "860.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.4000"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "1090.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "2100.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "430.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "2200.00",
                      "currency": "BRL"
                    }
                  },
                  {
                    "name": "Custódia de Cheques pré-datados: Inclusão",
                    "code": "NA",
                    "chargingTriggerInfo": "2% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "3000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.4000"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "5006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "2290.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "5800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.13",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.1500"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2000"
                      },
                      "customers": {
                        "rate": "0.4000"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3500"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.6800"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    }
                  ],
                  "minimumRate": "0.1450",
                  "maximumRate": "0.6900"
                }
              ],
              "requiredWarranties": [
                "CAUCAO"
              ],
              "termsConditions": "https://empresaa1.com/personal_invoice_financings"
            },

            {
              "type": "OUTROS_DIREITOS_CREDITORIOS_DESCONTADOS",
              "fees": {
                "services": [
                  {
                    "name": "Documentos em Custódia",
                    "code": "NA",
                    "chargingTriggerInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "150.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.20",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    }
                  ],
                  "minimumRate": "0.0889",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "CESSAO_DIREITOS_CREDITORIOS"
              ],
              "termsConditions": "https://empresaa1.com/personal_invoice_financings"
            },

            {
              "type": "OUTROS_TITULOS_DESCONTADOS",
              "fees": {
                "services": [
                  {
                    "name": "Documentos em Custódia",
                    "code": "NA",
                    "chargingTriggerInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "1000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "1200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "3072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7020.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "560.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8000.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.20",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7680"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.8100"
                }
              ],
              "requiredWarranties": [
                "CESSAO_DIREITOS_CREDITORIOS"
              ],
              "termsConditions": "https://empresaa1.com/personal_invoice_financings"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings",
    "prev": "",
    "next": "",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/personal-invoice-financings

Versão
1

Visão geral

Obtém os dados de Antecipação de Recebíveis.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Antecipação de Recebíveis para pessoa natural de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Direito Creditório Descontado (Invoice Financing), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePersonalInvoiceFinancings

Antecipação de recebíveis pessoa jurídica

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "businessInvoiceFinancings": [
            {
              "type": "DESCONTO_DUPLICATAS",
              "fees": {
                "services": [
                  {
                    "name": "Custódia de Duplicatas",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "35.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "55.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "62.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "15.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "87.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRate": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.15",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0100"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.0200"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.0390"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.0455"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0015",
                  "maximumRate": "0.5100"
                }
              ],
              "requiredWarranties": [
                "CESSAO_DIREITOS_CREDITORIOS"
              ],
              "termsConditions": "https://empresaa1.com/business_invoice_financings"
            },

            {
              "type": "DESCONTO_CHEQUES",
              "fees": {
                "services": [
                  {
                    "name": "Custódia de Cheques pré-datados: Inclusão",
                    "code": "NA",
                    "chargingTriggerInfo": "R$ 0,80",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "320.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "402.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "606.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "180.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "780.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                  "rate": "0.10",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.6865"
                }
              ],
              "requiredWarranties": [
                "CAUCAO"
              ],
              "termsConditions": "https://empresaa1.com/business_invoice_financings"
            },

            {
              "type": "ANTECIPACAO_FATURA_CARTAO_CREDITO",
              "fees": {
                "services": [
                  {
                    "name": "Aditamento de recebiveis",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.4000"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "6006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1890.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "7800.00",
                      "currency": "BRL"
                    }
                  },
                  {
                    "name": "Custódia de Duplicatas",
                    "code": "NA",
                    "chargingTriggerInfo": "2% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "3500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "4200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "4900.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "5006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "2290.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "5800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                "referentialRateIndexer": "POS_FIXADO_TR_TBF",
                "rate": "0.13",
                "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.1500"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2000"
                      },
                      "customers": {
                        "rate": "0.4000"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3500"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.6800"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    }
                  ],
                  "minimumRate": "0.1450",
                  "maximumRate": "0.6900"
                }
              ],
              "requiredWarranties": [
                "CAUCAO"
              ],
              "termsConditions": "https://empresaa1.com/business_invoice_financings"
            },

            {
              "type": "OUTROS_DIREITOS_CREDITORIOS_DESCONTADOS",
              "fees": {
                "services": [
                  {
                    "name": "Documentos em Custódia",
                    "code": "NA",
                    "chargingTriggerInfo": "R$ 0,80",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "7006.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1350.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "8800.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.20",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0350"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.0470"
                      },
                      "customers": {
                        "rate": "0.4000"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.5390"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.6123"
                      },
                      "customers": {
                        "rate": "0.2500"
                      }
                    }
                  ],
                  "minimumRate": "0.0220",
                  "maximumRate": "0.6510"
                }
              ],
              "requiredWarranties": [
                "CESSAO_DIREITOS_CREDITORIOS"
              ],
              "termsConditions": "https://empresaa1.com/business_invoice_financings"
            },

            {
              "type": "OUTROS_TITULOS_DESCONTADOS",
              "fees": {
                "services": [
                  {
                    "name": "Documentos em Custódia",
                    "code": "NA",
                    "chargingTriggerInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "2000.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "3200.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "5072.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "9008.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "1560.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "9700.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "OUTRAS_TAXAS_POS_FIXADAS",
                  "rate": "0.20",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0987"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.1600"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.5890"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0456",
                  "maximumRate": "0.6865"
                 }
              ],
              "requiredWarranties": [
                "CESSAO_DIREITOS_CREDITORIOS"
              ],
              "termsConditions": "https://empresaa1.com/business_invoice_financings"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings",
    "prev": "",
    "next": "",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/business-invoice-financings

Versão
1

Visão geral

Obtém os dados de Antecipação de Recebíveis.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Antecipação de Recebíveis para pessoa jurídica de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Direito Creditório Descontado (Invoice Financing), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBusinessInvoiceFinancing

Cartão de crédito de pessoa natural

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/personal-credit-cards HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/personal-credit-cards", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa da Organização A1",
          "cnpjNumber": "50685362000135",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "personalCreditCards": [
            {
              "name": "Cartão Universitário",
              "identification": {
                "product": {
                  "type": "CLASSIC_NACIONAL"
                },
                "creditCard": {
                  "network": "VISA"
                }
              },
              "rewardsProgram": {
                "hasRewardProgram": true,
                "rewardProgramInfo": "https://empresaa1.com/credit_cards_rewards"
              },
              "fees": {
                "services": [
                  {
                    "name": "ANUIDADE_CARTAO_BASICO_NACIONAL",
                    "code": "ANUIDADE_NACIONAL",
                    "chargingTriggerInfo": "Disponibilização de rede de estabelecimentos afiliados, instalada no País, para pagamentos de bens e serviços, cobrada no máximo uma vez a cada doze meses, admitido o parcelamento da cobrança.",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "20.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "35.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "55.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "69.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "19.50",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "72.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interest": {
                "rates": [
                  {
                    "referentialRateIndexer": "PRE_FIXADO",
                    "rate": "NA",
                    "applications": [
                      {
                        "interval": "1_FAIXA",
                        "indexer": {
                          "rate": "0.0987"
                        },
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "indexer": {
                          "rate": "0.1600"
                        },
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "indexer": {
                          "rate": "0.3600"
                        },
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "indexer": {
                          "rate": "0.5890"
                        },
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimumRate": "0.0845",
                    "maximumRate": "0.9000"
                  }
                ],
                "instalmentRates": [
                  {
                    "referentialRateIndexer": "PRE_FIXADO",
                    "rate": "NA",
                    "applications": [
                      {
                        "interval": "1_FAIXA",
                        "indexer": {
                          "rate": "0.0987"
                        },
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "indexer": {
                          "rate": "0.1600"
                        },
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "indexer": {
                          "rate": "0.3600"
                        },
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "indexer": {
                          "rate": "0.5890"
                        },
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimumRate": "0.0456",
                    "maximumRate": "0.0865"
                  }
                ],
                "otherCredits": [
                  {
                    "code": "SAQUE_A_CREDITO"
                  },
                  {
                    "code": "PAGAMENTOS_CONTAS"
                  }
                ]
              },
              "termsConditions": {
                "minimumFeeRate": "0.30",
                "additionalInfo": "NA",
                "elegibilityCriteriaInfo": "https://empresaa1.com/creditcards_elegibility_criteria",
                "closingProcessInfo": "https://empresaa1.com/creditcards_closing_process"
              }
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/personal-credit-cards",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/personal-credit-cards",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/personal-credit-cards"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/personal-credit-cards

Versão
1

Visão geral

Obtém os dados de produtos e serviços de cartões de crédito para pessoa natural.

Tags: Marca (Brand),Bandeira (Credit Card Network), CNPJ (CNPJ Number), Instituição Financeira (Company), Conta de pagamento pós-paga (Credit Card), Crédito Rotativo (Overdraft), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePersonalCreditCards

Cartão de crédito de pessoa jurídica

Exemplo de código

GET https://api.banco.com.br/open-banking/products-services/v1/business-credit-cards HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/business-credit-cards", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "businessCreditCards": [
            {
              "name": "Cartão Vantagens",
              "identification": {
                "product": {
                  "type": "CLASSIC_INTERNACIONAL"
                },
                "creditCard": {
                  "network": "MASTERCARD"
                }
              },
              "rewardsProgram": {
                "hasRewardProgram": false,
              },
              "fees": {
                "services": [
                  {
                    "name": "ANUIDADE_CARTAO_BASICO_INTERNACIONAL",
                    "code": "ANUIDADE_INTERNACIONAL",
                    "chargingTriggerInfo": "Disponibilização de rede de estabelecimentos afiliados, instalada no País e no exterior, para pagamentos de bens e serviços, cobrada no máximo uma vez a cada doze meses, admitido o parcelamento da cobrança.",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "20.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "35.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "55.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "68.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "19.50",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "72.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interest": {
                "rates": [
                  {
                    "referentialRateIndexer": "PRE_FIXADO",
                    "rate": "NA",
                    "applications": [
                      {
                        "interval": "1_FAIXA",
                        "indexer": {
                          "rate": "0.1500"
                        },
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "indexer": {
                          "rate": "0.2000"
                        },
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "indexer": {
                          "rate": "0.3500"
                        },
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "indexer": {
                          "rate": "0.6800"
                        },
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimumRate": "0.1099",
                    "maximumRate": "0.7000"
                  }
                ],
                "instalmentRates": [
                  {
                    "referentialRateIndexer": "PRE_FIXADO",
                    "rate": "NA",
                    "applications": [
                      {
                        "interval": "1_FAIXA",
                        "indexer": {
                          "rate": "0.1500"
                        },
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "indexer": {
                          "rate": "0.2000"
                        },
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "indexer": {
                          "rate": "0.3500"
                        },
                        "customers": {
                          "rate": "0.2500"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "indexer": {
                          "rate": "0.6800"
                        },
                        "customers": {
                          "rate": "0.3500"
                        }
                      }
                    ],
                    "minimumRate": "0.0900",
                    "maximumRate": "0.7500"
                  }
                ],
                "otherCredits": [
                  {
                    "code": "SAQUE_A_CREDITO"
                  },
                  {
                    "code": "PAGAMENTOS_CONTAS"
                  }
                ]
              },
              "termsConditions": {
                "minimumFeeRate": "0.40",
                "elegibilityCriteriaInfo": "https://empresaa1.com/creditcards_elegibility_criteria",
                "closingProcessInfo": "https://empresaa1.com/creditcards_closing_process"
              }
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/business-credit-cards",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/business-credit-cards",
    "prev": "string",
    "next": "string",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/business-credit-cards"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/business-credit-cards

Versão
1

Visão geral

Obtém os dados de produtos e serviços de cartões de crédito para pessoa jurídica.

Tags: Marca (Brand),Bandeira (Credit Card Network), CNPJ (CNPJ Number), Instituição Financeira (Company), Conta de pagamento pós-paga (Credit Card), Crédito Rotativo (Overdraft), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBusinessCreditCards

Adiantamento a Depositante pessoa natural

Exemplo de código

GET http://api.banco.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft", true);
req.send();

O comando acima retorna uma estrutura json como essa

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "50685362000135",
          "urlComplementaryList": "https://empresadaorganizacaoa.com/complementarylist",
          "personalUnarrangedAccountOverdraft": [
            {
              "fees": {
                "priorityServices": [
                  {
                    "name": "CONCESSAO_ADIANTAMENTO_DEPOSITANTE",
                    "code": "ADIANT_DEPOSITANTE",
                    "chargingTriggerInfo": "Levantamento de informações e avaliação de viabilidade e de riscos para a concessão de crédito em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite previamente pactuado de cheque especial, cobrada no máximo uma vez nos últimos trinta dias",
                    "prices": [
                      {
                        "interval": "1_FAIXA",
                        "value": "500.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.1500"
                        }
                      },
                      {
                        "interval": "2_FAIXA",
                        "value": "860.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3500"
                        }
                      },
                      {
                        "interval": "3_FAIXA",
                        "value": "1090.40",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.2000"
                        }
                      },
                      {
                        "interval": "4_FAIXA",
                        "value": "2100.00",
                        "currency": "BRL",
                        "customers": {
                          "rate": "0.3000"
                        }
                      }
                    ],
                    "minimum": {
                      "value": "430.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "2200.00",
                      "currency": "BRL"
                    }
                  }
                ]
              },
              "interestRates": [
                {
                  "referentialRateIndexer": "SEM_INDEXADOR_TAXA",
                  "rate": "0.65",
                  "applications": [
                    {
                      "interval": "1_FAIXA",
                      "indexer": {
                        "rate": "0.0187"
                      },
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "indexer": {
                        "rate": "0.2900"
                      },
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "indexer": {
                        "rate": "0.3600"
                      },
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "indexer": {
                        "rate": "0.7990"
                      },
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimumRate": "0.0056",
                  "maximumRate": "0.8565"
                }
              ],
              "termsConditions": "https://empresaa1.com/personal_unarranged_account_overdraft"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft",
    "prev": "",
    "next": "",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/personal-unarranged-account-overdraft

Versão
1

Visão geral

Obtém os dados de Adiantamento a Depositante para pessoa natural.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Adiantamento a Depositante para pessoa natural de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponsePersonalUnarrangedAccountOverdraft

Adiantamento a Depositante pessoa jurídica

Exemplo de código

GET http://api.banco.com.br/open-banking/products-services/v1/business-unarranged-account-overdraft HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/products-services/v1/business-unarranged-account-overdraft", true);
req.send();

O comando acima retorna uma estrutura json como essa

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "businessUnarrangedAccountOverdraft": {
            "fees": {
              "services": [
                {
                  "name": "CONCESSAO_ADIANTAMENTO_DEPOSITANTE",
                  "code": "ADIANT_DEPOSITANTE",
                  "chargingTriggerInfo": "Levantamento de informações e avaliação de viabilidade e de riscos para a concessão de crédito em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite previamente pactuado de cheque especial, cobrada no máximo uma vez nos últimos trinta dias",
                  "prices": [
                    {
                      "interval": "1_FAIXA",
                      "value": "500.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.1500"
                      }
                    },
                    {
                      "interval": "2_FAIXA",
                      "value": "860.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3500"
                      }
                    },
                    {
                      "interval": "3_FAIXA",
                      "value": "1090.40",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.2000"
                      }
                    },
                    {
                      "interval": "4_FAIXA",
                      "value": "2100.00",
                      "currency": "BRL",
                      "customers": {
                        "rate": "0.3000"
                      }
                    }
                  ],
                  "minimum": {
                    "value": "430.00",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "2200.00",
                    "currency": "BRL"
                  }
                }
              ]
            },
            "interestRates": {
              "referentialRateIndexer": "SEM_INDEXADOR_TAXA",
              "rate": "0.65",
              "applications": [
                {
                  "interval": "1_FAIXA",
                  "indexer": {
                    "rate": "0.0187"
                  },
                  "customers": {
                    "rate": "0.1500"
                  }
                },
                {
                  "interval": "2_FAIXA",
                  "indexer": {
                    "rate": "0.2900"
                  },
                  "customers": {
                    "rate": "0.3500"
                  }
                },
                {
                  "interval": "3_FAIXA",
                  "indexer": {
                    "rate": "0.3600"
                  },
                  "customers": {
                    "rate": "0.2000"
                  }
                },
                {
                  "interval": "4_FAIXA",
                  "indexer": {
                    "rate": "0.7990"
                  },
                  "customers": {
                    "rate": "0.3000"
                  }
                }
              ],
              "minimumRate": "0.0056",
              "maximumRate": "0.8565"
            },
            "termsConditions": "https://empresaa1.com/business_unarranged_account_overdraft"
          }
        }
      ]
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/products-services/v1/business-unarranged-account-overdraft",
    "first": "https://api.banco.com.br/open-banking/products-services/v1/business-unarranged-account-overdraft",
    "prev": "",
    "next": "",
    "last": "https://api.banco.com.br/open-banking/products-services/v1/business-unarranged-account-overdraft"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

GET /products-services/<versão>/business-unarranged-account-overdraft

Versão
1

Visão geral

Obtém os dados de Adiantamento a Depositante para pessoa jurídica.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Adiantamento a Depositante para pessoa jurídica de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Instituição Financeira (Company), Taxa Referencial – TR (Referential Rate), Indexador (Indexer) e Divulgação dos valores de tarifas e taxas de juros remuneratórias (Disclosure of Fees and Interest Rates).

Visão de alto de nível das estruturas de dados

Dicionário de dados

Fazer download do dicionário de dados

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseBusinessUnarrangedAccountOverdraft

Divulgação dos valores de tarifas e taxas de juros remuneratórias

Conforme disposto na Circular nº 4.015, art. 3º, para fins de compartilhamento dos valores de tarifas e taxas de juros remuneratórias nominal mensal dos produtos e serviços ofertados, as instituições devem compartilhar uma distribuição de frequência relativa dos valores cobrados dos clientes.

Segundo o Art. 6º da Instrução Normativa nº 32 BCB, de 2020: “O compartilhamento da distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas, além dos valores máximos e mínimos do universo, segmentados em pessoas naturais e jurídicas, bem como por tipo de serviço ou modalidade de operação e por indexador ou referencial, no caso de operações pós-fixadas.

§ 1º Admite-se que as instituições compartilhem dados relacionados à distribuição de frequência de que trata o caput em base atualizada em periodicidade mensal, divulgada no décimo dia útil de cada mês, a partir de janeiro de 2021, referente a valores cobrados de seus clientes no mês anterior.

§ 2º A distribuição de frequência relativa a taxas de juros divulgada conforme o § 1º deve corresponder às operações de crédito concedidas no mês anterior”’.

Desta forma, cada instituição deve, no momento de compartilhamento, ordenar sua base em ordem crescente de valores cobrados por tarifas e taxas de juros remuneratórias nominal mensal dos produtos e serviços ofertados durante o mês de apuração, segmentá-la em quatro faixas de mesmo valor e divulgar 10 valores:

Valores: máximo e mínimo do universo de clientes (i.e. 2 valores)

Mediana de cada faixa (i.e. 4 valores)

Percentual de clientes em cada faixa (i.e. 4 valores)

Devem ser utilizados no cálculo os valores devidos de tarifas e os valores cobrados de taxas de juros remuneratórias nominal mensal disponíveis nas bases de cliente no mês anterior.

Caso haja mais de 1 evento por cliente referente ao mesmo produto e/ou serviço, deverá ser considerado apenas 1 valor, calculado como a média aritmética dos valores das ocorrências daquele cliente.

Para taxas de juros remuneratórias nominal mensal, os valores compartilhados/divulgados serão os que correspondem às concessões no mês da apuração, segmentados em pessoas naturais e jurídicas, bem como por modalidade de operação e por indexador ou referencial, no caso de operações pós-fixadas.

Para tarifas, a segmentação é por pessoas naturais e jurídicas e por tipo de serviço referente a tarifa avulsa (fora do Pacote de Serviço) cobradas no mês de apuração, devendo-se considerar inclusive as de valor zero (ou isentas).

Tarifas – Apuração frequência e valores correspondentes

Serviço: tarifas avulsas cobradas no mês de apuração. Cada tarifa será informada separadamente, devendo ser informadas tanto as tarifas quanto as que satisfizerem os critérios de apuração. As tarifas de valor zero (ou isentas) fora de pacotes de serviços, caso tenham ocorrido no mês de referência, devem ser consideradas na distribuição de frequência relativa dos valores.

Tipo Pessoa: PN ou PJ

Período: Mês fechado, identificado como M-1

Base Clientes: clientes segregados por tipo de pessoa que tiveram cobrança da mesma tarifa avulsa (não inclusa no pacote de serviços) no mês de apuração. Caso haja mais de 1 evento por cliente, referente ao mesmo produto e/ou serviço, deverá ser considerado apenas 1 valor, calculado como a média aritmética dos valores das ocorrências daquele cliente

Processo de Apuração para cada tipo de tarifa que satisfizer critérios de apuração:

  1. Identificar clientes com mais de uma ocorrência de evento e calcular a média aritmética sobre valores cobrados;
  2. Enfileirar os valores em ordem crescente de grandeza;
  3. Definir menor (MenorVL) e maior valor (MaiorVL) relativos às tarifas enfileiradas em ordem crescente
  4. Definir: ( MaiorVL – MenorVL ) / 4 = Intervalo para definição faixas de valores (e se MenorVL = MaiorVL, então (MaiorVL – 0) / 4
  5. Calcular mediana dos valores em cada faixa
  6. Calcular o percentual de clientes por faixa ( soma dos valores apurados = 100% )

Exemplo de Uso:

Download do exemplo

Download do exemplo

Apuração frequência taxas juros remuneratórios

Modalidade: relativa às operações de crédito concedidas (contratadas) no mês da apuração (M-1 – mês anterior)

Tipo Pessoa: PN ou PJ

Taxa ou Indexador: referente ao custo da operação contratada e percentual de incidência (conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040, BCB) – Dado informativo

Período: mês fechado, identificado como M-1

Base Clientes: clientes segregados por tipo de pessoa (contrato) que tomou crédito de mesma modalidade no mês de apuração. Com mesmo tipo de taxa ou indexador e mesmo percentual aplicado. Caso haja mais de 1 evento por cliente referente a mesma modalidade e indexador deverá ser considerado apenas 1 valor, calculado como a média aritmética dos valores das ocorrências daquele cliente

Processo de apuração para cada tipo de indexador/taxa – percentual aplicado para cada modalidade que satisfizer os critérios de apuração

Para cada indexador/taxa e seu percentual, da modalidade apurada:

  1. Identificar clientes com mais de uma ocorrência de evento e calcular a média aritmética sobre valores cobrados;
  2. Enfileirar os valores em ordem crescente de grandeza;
  3. Definir menor (MenorVL) e maior valor (MaiorVL) relativos aos valores enfileirados em ordem crescente
  4. Calcular: ( MaiorVL – MenorVL ) / 4 = Intervalo para definição faixas de valores (e se MenorVL = MaiorVL, então 1. (MaiorVL – 0) / 4
  5. Calcular mediana dos valores em cada faixa
  6. Calcular o percentual de clientes por faixa ( soma dos valores apurados = 100% )

Exemplos de uso:

Download do exemplo

Download do exemplo

Download do exemplo

Download do exemplo

Download do exemplo

Especificação em OAS 3.0

Download da Especificação (OAS 3.0)

API - Admin

As APIs administrativas são recursos que podem ser consumidos apenas pelo diretório para avaliação e controle da qualidade dos serviços fornecidos pelas instituições financeiras.

Métricas

Exemplo de código:

GET https://api.banco.com.br/open-banking/admin/v1/metrics HTTP/1.1
Host: api.banco.com.br
Accept: application/json

var req = new XMLHttpRequest();
req.setRequestHeader("Accept", "application/json");
req.open("GET", "https://api.banco.com.br/open-banking/admin/v1/metrics", true);
req.send();

O comando acima retorna uma estrutura json como essa:

{
  "data": {
    "requestTime": "string",
    "availability": {
        "uptime" : {
            "generalUptimeRate" : "",
            "endpoints" : [
                {
                    "url" : "",
                    "uptimeRate" : ""
                }
            ]
        },
        "downtime" : {
            "generalDowntime" : 0,
            "scheduledOutage" : 0,
            "endpoints" : [
                {
                    "url" : "",
                    "partialDowntime" : 0
                }
            ]
        }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
    },
    "averageTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "peakTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "errors": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejections": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

GET /admin/<versão>/metrics

Versão
1

Visão geral

Este endpoint possibilita ao diretório consultar estatísticas operacionais das APIs disponibilizadas pelas instituições financeiras, a fim de avaliar a qualidade dos serviços fornecidos ao usuário final.

Parâmetros de entrada

Nome Origem Tipo Obrigatório Descrição
period query Enum AdminMetricsPeriod Não O período a ser retornado. Se não for informado, o padrão será ALL

Enum AdminMetricsPeriod

Propriedade Código Definição
period CURRENT Métricas do dia atual.
period ALL Métricas de todo o período disponível.

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseMetricsList

Especificação em OAS 3.0

Download da Especificação (OAS 3.0)

API - Dados cadastrais e transacionais de clientes

A ser publicada.

API - Iniciação de transação de pagamentos

A ser publicada.

API - Diretório e service desk

A ser publicada.

Schemas

ResponseBankingAgentsList

{
  "data": {
    "brand": {
        "name": "string",
        "companies": [
          {
            "name": "string",
            "cnpjNumber": "string",
            "contractors": [
              {
                "name": "string",
                "cnpjNumber": "string",
                "bankingAgents": [
                  {
                    "identification": {
                      "corporationName": "string",
                      "groupName": "string",
                      "cnpjNumber": "string",
                      "isUnderestablishment": "boolean"
                    },
                    "locations": [
                      {
                        "postalAddress": {
                          "address": "string",
                          "districtName": "string",
                          "townName": "string",
                          "countrySubDivision": "string",
                          "postCode": "string",
                          "additionalInfo": "string",
                          "ibgeCode": "string",
                          "country": "string",
                          "countryCode": "string",
                          "geographicCoordinates": {
                            "latitude": "string",
                            "longitude": "string"
                          }
                        },
                        "phones": [
                          {
                            "type": "string",
                            "countryCallingCode": "string",
                            "areaCode": "string",
                            "number": "string"
                          }
                        ],
                        "availability":{
                          "standards": [
                            {
                              "weekday": "string",
                              "openingTime": "string",
                              "closingTime": "string"
                            }
                          ],
                          "exception": "string",
                          "isPublicAccessAllowed": "boolean"
                        }
                      }
                    ],
                    "services": [
                      {
                        "name": "string",
                        "code": "string",
                        "additionalInfo": "string"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": "string",
    "totalPages": "string"
  }
}
Nome Tipo Obrigatório Definição
data object Sim
brand BankingAgentsBrand Sim Organização controladora do grupo de instituições financeiras.
links LinksPaginated Sim
meta MetaPaginated Sim

BankingAgentsBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "contractors": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "bankingAgents": [
            {
              "identification": {
                "corporationName": "string",
                "groupName": "string",
                "cnpjNumber": "string",
                "isUnderestablishment": "boolean"
              },
              "locations": [
                {
                  "postalAddress": {
                    "address": "string",
                    "districtName": "string",
                    "townName": "string",
                    "countrySubDivision": "string",
                    "postCode": "string",
                    "additionalInfo": "string",
                    "ibgeCode": "string",
                    "country": "string",
                    "countryCode": "string",
                    "geographicCoordinates": {
                      "latitude": "string",
                      "longitude": "string"
                    }
                  },
                  "phones": [
                    {
                      "type": "string",
                      "countryCallingCode": "string",
                      "areaCode": "string",
                      "number": "string"
                    }
                  ],
                  "availability":{
                    "standards": [
                      {
                        "weekday": "string",
                        "openingTime": "string",
                        "closingTime": "string"
                      }
                    ],
                    "exception": "string",
                    "isPublicAccessAllowed": "boolean"
                  }
                }
              ],
              "services": [
                {
                  "name": "string",
                  "code": "string",
                  "additionalInfo": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Marca reportada pelo participante do Open Banking. O conceito a que se refere a 'marca' utilizada está em definição pelos participantes.
companies BankingAgentsCompanies Sim Lista de instituições pertencentes à marca.

BankingAgentsCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "contractors": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "bankingAgents": [
        {
          "identification": {
            "corporationName": "string",
            "groupName": "string",
            "cnpjNumber": "string",
            "isUnderestablishment": "boolean"
          },
          "locations": [
            {
              "postalAddress": {
                "address": "string",
                "districtName": "string",
                "townName": "string",
                "countrySubDivision": "string",
                "postCode": "string",
                "additionalInfo": "string",
                "ibgeCode": "string",
                "country": "string",
                "countryCode": "string",
                "geographicCoordinates": {
                  "latitude": "string",
                  "longitude": "string"
                }
              },
              "phones": [
                {
                  "type": "string",
                  "countryCallingCode": "string",
                  "areaCode": "string",
                  "number": "string"
                }
              ],
              "availability":{
                "standards": [
                  {
                    "weekday": "string",
                    "openingTime": "string",
                    "closingTime": "string"
                  }
                ],
                "exception": "string",
                "isPublicAccessAllowed": "boolean"
              }
            }
          ],
          "services": [
            {
              "name": "string",
              "code": "string",
              "additionalInfo": "string"
            }
          ]
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pelo Correspondente Bancário no país. p.ex.'Empresa da Organização A'
cnpjNumber string Sim Número completo do CNPJ da instituição responsável pelo Correspondente Bancário no país - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara.
contractors BankingAgentsContractor Sim Relação de informações de um contratante do serviço de correspondente.

BankingAgentsContractor

{
  "name": "string",
  "cnpjNumber": "string",
  "bankingAgents": [
    {
      "identification": {
        "corporationName": "string",
        "groupName": "string",
        "cnpjNumber": "string",
        "isUnderestablishment": "boolean"
      },
      "locations": [
        {
          "postalAddress": {
            "address": "string",
            "districtName": "string",
            "townName": "string",
            "countrySubDivision": "string",
            "postCode": "string",
            "additionalInfo": "string",
            "ibgeCode": "string",
            "country": "string",
            "countryCode": "string",
            "geographicCoordinates": {
              "latitude": "string",
              "longitude": "string"
            }
          },
          "phones": [
            {
              "type": "string",
              "countryCallingCode": "string",
              "areaCode": "string",
              "number": "string"
            }
          ],
          "availability":{
            "standards": [
              {
                "weekday": "string",
                "openingTime": "string",
                "closingTime": "string"
              }
            ],
            "exception": "string",
            "isPublicAccessAllowed": "boolean"
          }
        }
      ],
      "services": [
        {
          "name": "string",
          "code": "string",
          "additionalInfo": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Descrição
name string Sim Nome do contratante do serviço do correspondente.
cnpjNumber string Sim CNPJ do Contrante.
bankingAgents BankingAgent Sim Lista de correspondentes bancários.

BankingAgent

{
  "identification": {
    "corporationName": "string",
    "groupName": "string",
    "cnpjNumber": "string",
    "isUnderestablishment": "boolean"
  },
  "locations": [
    {
      "postalAddress": {
        "address": "string",
        "districtName": "string",
        "townName": "string",
        "countrySubDivision": "string",
        "postCode": "string",
        "additionalInfo": "string",
        "ibgeCode": "string",
        "country": "string",
        "countryCode": "string",
        "geographicCoordinates": {
          "latitude": "string",
          "longitude": "string"
        }
      },
      "phones": [
        {
          "type": "string",
          "countryCallingCode": "string",
          "areaCode": "string",
          "number": "string"
        }
      ],
      "availability":{
        "standards": [
          {
            "weekday": "string",
            "openingTime": "string",
            "closingTime": "string"
          }
        ],
        "exception": "string",
        "isPublicAccessAllowed": "boolean"
      }
    }
  ],
  "services": [
    {
      "name": "string",
      "code": "string",
      "additionalInfo": "string"
    }
  ]
}
Nome Tipo Obrigatório Descrição
identification BankingAgentsIdentification Sim Dados de identificação do correspondente.
locations BankingAgentLocation Sim Relação de informações referentes as localizações dos Correspondentes bancários
services BankingAgentsService Sim Serviços fornecidos pelo correspondente.

BankingAgentsIdentification

{
  "corporationName": "string",
  "groupName": "string",
  "cnpjNumber": "string",
  "isUnderestablishment": "boolean"
}
Nome Tipo Obrigatório Descrição
corporationName string Sim Nome do Correspondente Bancário.
groupName string Não Nome do conglomerado ao qual pertence o agente bancário.
cnpjNumber string Sim CNPJ do Correspondente.
isUnderestablishment boolean Não Indicador do Correspondente Bancário ser um Substabelecimento (são empresas que foram contratadas por um correspondente bancário para prestar serviços. A empresa substabelecida é tratada como um correspondente do banco e tem praticamente os mesmos direitos e obrigações que possui o correspondente direto)

BankingAgentLocation

{
  "postalAddress": {
    "address": "string",
    "districtName": "string",
    "townName": "string",
    "countrySubDivision": "string",
    "postCode": "string",
    "additionalInfo": "string",
    "ibgeCode": "string",
    "country": "string",
    "countryCode": "string",
    "geographicCoordinates": {
      "latitude": "string",
      "longitude": "string"
    }
  },
  "phones": [
    {
      "type": "string",
      "countryCallingCode": "string",
      "areaCode": "string",
      "number": "string"
    }
  ],
  "availability":{
    "standards": [
      {
        "weekday": "string",
        "openingTime": "string",
        "closingTime": "string"
      }
    ],
    "exception": "string",
    "isPublicAccessAllowed": "boolean"
  }
}
Nome Tipo Obrigatório Descrição
postalAddress BankingAgentsPostalAddress Sim Endereço do correspondente.
phones BankingAgentsPhone Não Lista de telefones do correspondente.
availability BankingAgentsAvailability

BankingAgentsPostalAddress

{
  "address": "string",
  "districtName": "string",
  "townName": "string",
  "countrySubDivision": "string",
  "postCode": "string",
  "additionalInfo": "string",
  "ibgeCode": "string",
  "country": "string",
  "countryCode": "string",
  "geographicCoordinates": {
    "latitude": "string",
    "longitude": "string"
  }
}
Nome Tipo Obrigatório Descrição
address string Sim informação referente ao endereço do Correspondente Bancário informado: Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver)
districtName string Sim Bairro.
townName string Sim Cidade.
countrySubDivision string Sim Estado.
postCode string Sim CEP.
additionalInfo string Não Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir: 'Loja B', 'Fundos', 'Casa 2', 'Lote C'
ibgeCode string Não Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação. p.ex.'3550308'
country string Não Nome do país. p.ex. Brasil
countryCode string Não Código do pais de acordo com o código “alpha3” do ISO-3166.p.ex.'BRA'
geographicCoordinates BankingAgentsGeographicCoordinates Não Informação referente a geolocalização informada.

BankingAgentsGeographicCoordinates

    {
    "latitude": "string",
    "longitude": "string"
    }
Nome Tipo Obrigatório Descrição
latitude string Não Informação da Latitude referente a geolocalização informada. Entre -90 e 90.p.ex. '-90.8365180'
longitude string Não Informação da Longitude referente a geolocalização informada. Entre -180 e 180.p.ex. '-180.836519'

BankingAgentsPhone

    {
      "type": "string",
      "countryCallingCode": "string",
      "areaCode": "string",
      "number": "string"
    }
Nome Tipo Obrigatório Descrição
type string Não Identificação do Tipo de telefone da dependência. p.ex.FIXO, MOVEL
countryCallingCode string Não Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Canal - se houver. p.ex. '55'
areaCode string Não Número de DDD (Discagem Direta à Distância) do telefone da dependência - se houver. p.ex. '19'
number string Não Número de telefone da dependência - se houver

BankingAgentsAvailability

{
  "standards": [
    {
      "weekday": "string",
      "openingTime": "string",
      "closingTime": "string"
    }
  ],
  "exception": "string",
  "isPublicAccessAllowed": "boolean"
}

Nome Tipo Obrigatório Descrição
standards BankingAgentsStandard Relação da disponbilidade de atendimento
exception string Não Em campo texto devem ser registradas todas as Exceções para o não atendimento. p.ex. 'Exceto feriados municipais, nacionais e estaduais'
isPublicAccessAllowed boolean Não Indica se a instalação do Correspondente Bancário tem acesso restrito a clientes, por exemplo. p.ex. 'FALSO' (restrito)

BankingAgentsStandard

    {
      "weekday": "string",
      "openingTime": "string",
      "closingTime": "string"
    }
Nome Tipo Obrigatório Descrição
weekday Enum WeekDay Sim Em formato texto, seguindo o domínio apresentado, devem ser colocados os dias da semana
openingTime TimeString Não Horário padrão de início de atendimento pelo Correspondente Bancário. (Uma string que representa a hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format). p.ex. '10:00:57Z')
closingTime TimeString Não Horário padrão de encerramento de atendimento pelo Correspondente Bancário. (Uma string que representa a hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format). p.ex. '16:00:57Z')

BankingAgentsService

{
  "name": "string",
  "code": "string",
  "additionalInfo": "string"
}
Nome Tipo Obrigatório Descrição Restrições
name Enum BankingAgentsServicesName Sim Relação dos Nomes de serviços prestados pelo Correspondente.
code Enum BankingAgentsServicesCode Sim Relação dos Códigos relativos aos serviços prestados pelo Correspondente
additionalInfo string Não Detalhes adicionais sobre os serviços prestados. Será preenchido se selecionada a opção "OUTROS' serviços

Enum BankingAgentsServicesName

Propriedade Código Definição
name RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_ABERTURA_CONTAS_DEPOSITOS_VISTA_PRAZO_POUPANCA_MANTIDOS_INSTITUICAO_CONTRATANTE Recepção e encaminhamento de propostas de abertura de contas.
name REALIZACAO_RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS_VISANDO_MOVIMENTACAO_CONTAS_DEPOSITOS_TITULARIDADE_CLIENTES_MANTIDAS_INSTITUICAO_CONTRATANTE Realização de recebimentos, pagamentos e transferências eletrônicas.
name RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA_OUTRAS_ATIVIDADES_DECORRENTES_EXECUCAO_CONTRATOS_CONVENIOS_PRESTACAO_SERVICOS Recebimentos e pagamentos de qualquer natureza.
name EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGAMENTO_CURSADAS_INTERMEDIO_INSTITUICAO_CONTRATANTE_SOLICITACAO_CLIENTES_USUARIOS Execução ativa e passiva de ordens de pagamento.
name RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_OPERACAO_CREDITO_ARRENDAMENTO_MERCANTIL_CONCESSAO_INSTITUICAO_CONTRATANTE Recepção e encaminhamento de propostas de operações de crédito e de arrendamento mercantil.
name RECEBIMENTOS_PAGAMENTOS_RELACIONADOS_LETRAS_CAMBIO_ACEITE_INSTITUICAO_CONTRATANTE Recebimento e pagamentos relacionados a letras de câmbio de aceite da instituição.
name RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_FORNECIMENTO_CARTAO_CREDITO_RESPONSABILIDADE_INSTITUICAO_CONTRATANTE Recepção e encaminhamento de propostas de fornecimento de cartões de crédito.
name REALIZACAO_OPERACOES_CAMBIO_RESPONSABILIDADE_INSTITUICAO_CONTRATANTE Realização de operações de câmbio.
name OUTROS Outros

Enum BankingAgentsServicesCode

Propriedade Código Definição
code RECEBE_ENCAMINHA_PROPOSTAS_ABERTURA_CONTAS Recepção e encaminhamento de propostas de abertura de contas.
code REALIZA_RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS Realização de recebimentos, pagamentos e transferências eletrônicas.
code RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA_EXECUCAO_CONTRATOS_CONVENIO Recebimentos e pagamentos de qualquer natureza.
code EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGAMENTO Execução ativa e passiva de ordens de pagamento.
code RECEBE_ENCAMINHA_PROPOSTAS_CREDITO_ARRENDAMENTO_MERCANTIL Recepção e encaminhamento de propostas de operações de crédito e de arrendamento mercantil.
code RECEBE_PAGAMENTOS_RELACIONADOS_LETRAS_CAMBIO_ACEITE_INSTITUICAO Recebimento e pagamentos relacionados a letras de câmbio de aceite da instituição.
code RECEBE_ENCAMINHA_PROPOSTAS_FORNECIMENTO_CARTAO_CREDITO Recepção e encaminhamento de propostas de fornecimento de cartões de crédito.
code REALIZA_OPERACOES_CAMBIO Realização de operações de câmbio.
code OUTROS Outros.

ResponseBranchesList

{
  "data": {
    "brand": {
        "name": "string",
        "companies": [
          {
            "name": "string",
            "cnpjNumber": "string",
            "urlComplementaryList": "string",
            "branches": [
              {
                "identification": {
                  "type": "string",
                  "code": "string",
                  "checkDigit": "string",
                  "name": "string",
                  "relatedBranch": "string",
                  "openingDate": "string"
                },
                "postalAddress": {
                  "address": "string",
                  "additionalInfo": "string",
                  "districtName": "string",
                  "townName": "string",
                  "ibgeCode": "string",
                  "countrySubDivision": "string",
                  "postCode": "string",
                  "country": "string",
                  "countryCode": "string",
                  "geographicCoordinates": {
                    "latitude": "string",
                    "longitude": "string"
                  }
                },
                "availability": {
                  "standards": [
                    {
                      "weekday": "string",
                      "openingTime": "string",
                      "closingTime": "string"
                    }
                  ],
                  "exception": "string",
                  "isPublicAccessAllowed": "string"
                },
                "phones": [
                  {
                    "type": "string",
                    "countryCallingCode" : "string",
                    "areaCode": "string",
                    "number": "string"
                  }
                ],
                "services": [
                  {
                    "name": "string",
                    "code": "string",
                    "additionalInfo": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": "integer",
    "totalPages": "integer"
  }
}
Nome Tipo Obrigatório Definição
data object Sim
brand BranchesBrand Sim Organização controladora do grupo de instituições financeiras.
links LinksPaginated Sim
meta MetaPaginated Sim

BranchesBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "branches": [
        {
          "identification": {
            "type": "string",
            "code": "string",
            "checkDigit": "string",
            "name": "string",
            "relatedBranch": "string",
            "openingDate": "string"
          },
          "postalAddress": {
            "address": "string",
            "additionalInfo": "string",
            "districtName": "string",
            "townName": "string",
            "ibgeCode": "string",
            "countrySubDivision": "string",
            "postCode": "string",
            "country": "string",
            "countryCode": "string",
            "geographicCoordinates": {
              "latitude": "string",
              "longitude": "string"
            }
          },
          "availability": {
            "standards": [
              {
                "weekday": "string",
                "openingTime": "string",
                "closingTime": "string"
              }
            ],
            "exception": "string",
            "isPublicAccessAllowed": "string"
          },
          "phones": [
            {
              "type": "string",
              "countryCallingCode" : "string",
              "areaCode": "string",
              "number": "string"
            }
          ],
          "services": [
            {
              "name": "string",
              "code": "string",
              "additionalInfo": "string"
            }
          ]
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Marca reportada pelo participante do Open Banking. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
companies BranchesCompany Sim Companies traz uma lista de todas as instituições da Marca

BranchesCompany

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "branches": [
    {
      "identification": {
        "type": "string",
        "code": "string",
        "checkDigit": "string",
        "name": "string",
        "relatedBranch": "string",
        "openingDate": "string"
      },
      "postalAddress": {
        "address": "string",
        "additionalInfo": "string",
        "districtName": "string",
        "townName": "string",
        "ibgeCode": "string",
        "countrySubDivision": "string",
        "postCode": "string",
        "country": "string",
        "countryCode": "string",
        "geographicCoordinates": {
          "latitude": "string",
          "longitude": "string"
        }
      },
      "availability": {
        "standards": [
          {
            "weekday": "string",
            "openingTime": "string",
            "closingTime": "string"
          }
        ],
        "exception": "string",
        "isPublicAccessAllowed": "string"
      },
      "phones": [
        {
          "type": "string",
          "countryCallingCode" : "string",
          "areaCode": "string",
          "number": "string"
        }
      ],
      "services": [
        {
          "name": "string",
          "code": "string",
          "additionalInfo": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Descrição
name string Sim Nome da Instituição, pertencente à Marca, responsável pela Dependência. p. ex. 'Empresa da Organização A'
cnpjNumber string Sim Número completo do CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara
urlComplementaryList string Não URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. URLs são limitadas a 2048 caracteres mas, para o contexto do Sistema Financeiro aberto, será adotado a metade deste tamanho. p.ex. 'https://example.com/mobile-banking'
branches Branch Sim Lista de Dependências de uma Instituição

Branch

{
  "identification": {
    "type": "string",
    "code": "string",
    "checkDigit": "string",
    "name": "string",
    "relatedBranch": "string",
    "openingDate": "string"
  },
  "postalAddress": {
    "address": "string",
    "additionalInfo": "string",
    "districtName": "string",
    "townName": "string",
    "ibgeCode": "string",
    "countrySubDivision": "string",
    "postCode": "string",
    "country": "string",
    "countryCode": "string",
    "geographicCoordinates": {
      "latitude": "string",
      "longitude": "string"
    }
  },
  "availability": {
    "standards": [
      {
        "weekday": "string",
        "openingTime": "string",
        "closingTime": "string"
      }
    ],
    "exception": "string",
    "isPublicAccessAllowed": "string"
  },
  "phones": [
    {
      "type": "string",
      "countryCallingCode" : "string",
      "areaCode": "string",
      "number": "string"
    }
  ],
  "services": [
    {
      "name": "string",
      "code": "string",
      "additionalInfo": "string"
    }
  ]
}
Propriedade Código Obrigatório Definição
identification BranchIdentification Sim Dados de identificação na dependência.
postalAddress BranchPostalAddress Sim Endereço na dependência.
availability BranchAvailability Sim Dias e horários de funcionamento na dependência.
phones BranchPhone Sim Lista de telefones da Dependência.
services BranchService Sim Traz a relação de serviços disponbilizados pelo Canal de Atendimento

BranchIdentification

{
  "type": "string",
  "code": "string",
  "checkDigit": "string",
  "name": "string",
  "relatedBranch": "string",
  "openingDate": "string"
}
Propriedade Código Obrigatório Definição Restrições
type Enum BranchIdentificationType Sim Tipo da dependência, segundo a regulamentação do Bacen, na Resolução Nº 4072, de 26 de abril de 2012: Dependência de instituições financeiras e demais instituições, autorizadas a funcionar pelo Banco Central do Brasil, destinada à prática das atividades para as quais a instituição esteja regularmente habilitada.
code string Sim Código identificador da dependência. Ex. '3006','3035', '1382', '2516', '2856'.
checkDigit string Sim Dígito verificador do código da dependência.
name string Sim Nome da dependência, exemplos: 3006, 'SP Ponte Morumbi', 3035, 'Uberaba São Benedito', 1382, 'ALPHAVILLE-BARUERI', 2516, 'PRIME-ALPHAVILLE', 2856, 'CID.DE DEUS-U.OSASCO'
relatedBranch string Não Código da agência vinculada ao Posto de Atendimento. Preencher como o código da agência vinculada ao Posto de Atendimento - se aplicável
openingDate string Não Data de abertura da dependência (uma string com data conforme especificação RFC-3339. p.ex. 2014-03-19).

Enum BranchIdentificationType

Propriedade Código Definição
type AGENCIA Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória.
type POSTO_ATENDIMENTO Posto de Atendimento é a dependência subordinada a agência ou à sede da instituição financeira, destinada ao atendimento ao público no exercício de uma ou mais de suas atividades, podendo ser fixo ou móvel. Segundo Art.15. Os Postos de Atendimento Bancário (PAB), Postos Avançados de Atendimento (PAA), Postos de Atendimento Transitórios (PAT), Postos de Compra de Ouro (PCO), Postos de Atendimento Cooperativo (PAC), Postos de Atendimento de Microcrédito (PAM), Postos Bancários de Arrecadação e Pagamento (PAP) e os Postos de Câmbio atualmente em funcionamento serão considerados PA.
type POSTO_ATENDIMENTO_ELETRONICO Posto de Atendimento Eletrônico é a dependência constituída por um ou mais terminais de autoatendimento, subordinada a agência ou à sede da instituição, destinada à prestação de serviços por meio eletrônico, podendo ser fixo ou móvel, permanente ou transitório.
type UNIDADE_ADMINISTRATIVA_DESMEMBRADA Unidade Administrativa Desmembrada (UAD) segundo a Resolução 4072 , BCB, 2012, no Art. 8º "... é dependência destinada à execução de atividades administrativas da instituição, vedado o atendimento ao público".

BranchPostalAddress

{
  "address": "string",
  "additionalInfo": "string",
  "districtName": "string",
  "townName": "string",
  "ibgeCode": "string",
  "countrySubDivision": "string",
  "postCode": "string",
  "country": "string",
  "countryCode": "string",
  "geographicCoordinates": {
    "latitude": "string",
    "longitude": "string"
  }
}
Nome Tipo Obrigatório Descrição
address string Sim Deverá trazer toda a informação referente ao endereço da dependência informada: Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver), como, p.ex.: 'R Diamatina, 59, bloco 35, fundos', 'Praça da Boa Vontade s/n'
additionalInfo string Não Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir: 'Loja B', 'Fundos', 'Casa 2', 'Lote C'
districtName string Sim Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas. p.ex: 'Paraíso'
townName string Sim O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado. p.ex. 'São Paulo'
ibgeCode string Não Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação. p.ex.'3550308'
countrySubDivision string Sim Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros
postCode string Sim Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311-000'
country string Não Nome do país. p.ex. Brasil
countryCode string Não Código do pais de acordo com o código “alpha3” do ISO-3166.p.ex.'BRA'
geographicCoordinates BranchesGeographicCoordinates Não Informação referente a geolocalização informada.

BranchesGeographicCoordinates

{
  "latitude": "string",
  "longitude": "string"
}
Nome Tipo Obrigatório Descrição
latitude string Não Informação da Latitude referente a geolocalização informada. Entre -90 e 90.p.ex. '-90.8365180'
longitude string Não Informação da Longitude referente a geolocalização informada. Entre -180 e 180.p.ex. '-180.836519'

BranchAvailability

{
  "standards": [
    {
      "weekday": "string",
      "openingTime": "string",
      "closingTime": "string"
    }
  ],
  "exception": "string",
  "isPublicAccessAllowed": "boolean"
}
Nome Tipo Obrigatório Descrição
standards Array Sim Lista disponibilidade padrão da depêndencia por dias da semana
weekday Enum WeekDay Sim Em formato texto, seguindo o domínio apresentado, devem ser colocados os dias da semana
openingTime TimeString Sim Horário padrão de início de atendimento da Dependência. (Uma string que representa a hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format). p.ex. '10:00:57Z')
closingTime TimeString Sim Horário padrão de encerramento de atendimento da Dependência. (Uma string que representa a hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format). p.ex. '16:00:57Z')
exception string Sim Em campo texto devem ser registradas todas as Exceções para o não atendimento. p.ex. 'Exceto feriados municipais, nacionais e estaduais'
isPublicAccessAllowed boolean Não Indica se a instalação da Dependência tem acesso restrito a clientes, por exemplo. p.ex. 'false' (restrito)

Enum WeekDay

Dia Código
Domingo DOMINGO
Segunda Feira SEGUNDA_FEIRA
Terça Feira TERCA_FEIRA
Quarta Feira QUARTA_FEIRA
Quinta Feira QUINTA_FEIRA
Sexta Feira SEXTA_FEIRA
Sábado SABADO

BranchPhone

{
  "type": "string",
  "countryCallingCode" : "string",
  "areaCode": "string",
  "number": "string"
}
Nome Tipo Obrigatório Descrição
type Enum BranchPhoneType Sim Identificação do Tipo de telefone da dependência. p.ex.FIXO, MOVEL
countryCallingCode string Não Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Canal - se houver. p.ex. '55'
areaCode string Não Número de DDD (Discagem Direta à Distância) do telefone da dependência - se houver. p.ex. '19'
number string Não Número de telefone da dependência - se houver

Enum BranchPhoneType

Propriedade Código Definição
type FIXO Telefone fixo.
type MOVEL Telefone móvel.

BranchService

{
  "name": "string",
  "code": "string",
  "additionalInfo": "string"
}
Nome Tipo Obrigatório Descrição
name Enum BranchServicesNames Sim Nome dos Serviços efetivamente prestados pelo Canal de Atendimento, discriminados na Seção 4.2 da Resolução nº 35, BCB, 2020
code Enum BranchServicesCodes Sim Código dos Serviços efetivamente prestados pelo Canal de Atendimento
additionalInfo string Não Texto livre para complementar informação relativa ao Serviço disponível, quando for selecionada a opção 'OUTROS_PRODUTOS_SERVICOS'

Enum BranchServicesNames

Propriedade Código Definição
name ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA Abertura de Contas, depósitos ou Pagamento Pré Paga
name SAQUE_MOEDA_EM_ESPECIE Saques de Moedas em Espécie
name RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA Recebimentos e pagamentos de qualquer natureza
name TRANSFERENCIAS_ELETRONICAS_VISANDO_MOVIMENTACAO_CONTAS_DEPOSITOS_OU_PAGAMENTO_TITULARIDADE_CLIENTES Transferências Eletrônicas
name CONSULTA_SALDOS_EXTRATOS_CONTAS_DEPOSITOS_CONTAS_PAGAMENTOS Consulta de Saldos e Extratos
name APLICACOES_RESGATES_INVESTIMENTOS Aplicações, Resgates e Investimentos
name EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGAMENTO_SOLICITACAO_CLIENTES_USUARIOS Execução Ativa e Passiva, Ordens de Pagamento e Solicitações de Clientes e Usuários.
name DEPOSITOS_MOEDA_ESPECIE_CHEQUE Depósitos de Moeda em Espécie ou Cheque
name OPERACOES_CREDITO_BEM_COMO_OUTROS_SERVICOS_PRESTADOS_ACOMPANHAMENTO_OPERACAO Operações de Crédito
name CARTAO_CREDITO Cartão de Crédito
name SEGUROS Seguros
name OPERACOES_ARRENDAMENTO_MERCANTIL Operações de Arrendamento Mercantil
name ABERTURA_CONTA_PAGAMENTO_POS_PAGA Abertura de Conta Pagamento Pós Paga
name COMPRA_VENDA_MOEDA_ESTRANGEIRA_ESPECIE Compra e Venda de Moeda Estrangeira em Espécie
name COMPRA_VENDA_CHEQUE_CHEQUE_VIAGEM_BEM_COMO_CARGA_MOEDA_ESTRANGEIRA_CARTAO_PRE_PAGO Compra e Venda em Cheque, Cheque Viagem, Cartão Pré-Pago e Carga em Moeda Entrangeira
name COMPRA_VENDA_OURO Compra e Venda de Ouro
name OUTROS_PRODUTOS_SERVICOS Outros Produtos e Serviços
name CANCELAMENTO Cancelamento
name INFORMACOES Informações
name RECLAMACOES Reclamações

Enum BranchServicesCodes

Propriedade Código Definição
code ABRE_CONTA_DEPOSITO_OU_PRE_PAGA Abertura de Contas, depósitos ou Pagamento Pré Paga
code SAQUE_MOEDA_ESPECIE Saques de Moedas em Espécie
code RECEBE_PAGA_QUALQUER_NATUREZA Recebimentos e pagamentos de qualquer natureza
code TRANSFERENCIAS_ELETRONICAS_MOVIMENTA_CONTAS_DEPOSITOS_OU_PAGTO_TITULARES_CLIENTES Transferências Eletrônicas
code CONSULTA_SALDOS_EXTRATOS_CONTAS_DEPOSITOS_PAGTOS Consulta de Saldos e Extratos
code APLICA_RESGATA_INVESTIMENTOS Aplicações, Resgates e Investimentos
code EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGTO Execução Ativa e Passiva, Ordens de Pagamento e Solicitações de Clientes e Usuários.
code DEPOSITO_MOEDA_ESPECIE_CHEQUE Depósitos de Moeda em Espécie ou Cheque
code OPERA_CREDITO_OUTROS_SERVICOS_ACOMPANHA_OPERACAO Operações de Crédito
code CARTAO_CREDITO Cartão de Crédito
code SEGUROS Seguros
code OPERA_ARRENDAMENTO_MERCANTIL Operações de Arrendamento Mercantil
code ABERTURA_CONTA_PAGAMENTO_POS_PAGA Abertura de Conta Pagamento Pós Paga
code COMPRA_VENDA_MOEDA_ESTRANGEIRA_ESPECIE Compra e Venda de Moeda Estrangeira em Espécie
code COMPRA_VENDA_CHEQUE_CHEQUE_VIAGEM_CARGA_MOEDA_ESTRANGEIRA_CARTAO_PRE_PAGO Compra e Venda em Cheque, Cheque Viagem, Cartão Pré-Pago e Carga em Moeda Entrangeira
code COMPRA_VENDA_OURO Compra e Venda de Ouro
code OUTROS_PRODUTOS_SERVICOS Outros Produtos e Serviços
code CANCELAMENTO Cancelamento
code INFORMACOES Informações
code RECLAMACOES Reclamações

ResponseElectronicChannelsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "electronicChannels": [
            {
              "identification": {
                "type": "string",
                "additionalInfo": "string",
                "urls": [
                  "string"
                ]
              },
              "services": [
                {
                  "name": "string",
                  "code": "string",
                  "additionalInfo": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": "integer",
    "totalPages": "integer"
  }
}
Nome Tipo Obrigatório Definição
data object Sim
brand ElectronicChannelsBrand Sim Organização controladora do grupo de instituições financeiras.
links LinksPaginated Sim
meta MetaPaginated Sim

ElectronicChannelsBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "electronicChannels": [
        {
          "identification": {
            "type": "string",
            "additionalInfo": "string",
            "urls": [
              "string"
            ]
          },
          "services": [
            {
              "name": "string",
              "code": "string",
              "additionalInfo": "string"
            }
          ]
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Marca reportada pelo participante do Open Banking. O conceito a que se refere a 'marca' utilizada está em definição pelos participantes.
companies ElectronicChannelsCompanies Sim Lista de instituições pertencentes à marca.

ElectronicChannelsCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "channels": [
    {
      "identification": {
        "type": "string",
        "additionalInfo": "string",
        "urls": [
          "string"
        ]
      },
      "services": [
        {
          "name": "string",
          "code": "string",
          "additionalInfo": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição Restrições
name string