NAV

Introdução

Este documento é o resultado do trabalho conjunto do GT da Convenção – Interfaces, formado por integrantes da ABBC, ABCD, Abecs, ABFintechs, Abipag, Abranet, Camara e-net, OCB, BACEN e Febraban, baseado na proposta inicial apresentada pela Febraban (Federação Brasileira de Bancos) para implementação do Sistema Financeiro Aberto no Brasil (Open Banking). A documentação a seguir visa estabelecer padrões de desenvolvimento de APIs por parte das instituições financeiras, instituições de pagamento e demais instituições autorizadas pelo Banco Central do Brasil, além de conter informações adicionais para melhor entendimento do uso dos dados disponibilizados.

Nossa proposta tem como base o modelos do Open Banking do Reino Unido e Austrália, com as devidas adaptações ao cenário bancário brasileiro.

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á 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 sua aplicação for relevante/apropriada 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 resource payloads reflete 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, com cada um dos lançamentos tendo um prazo pré-estabelecido para ser implementado pelos participantes, 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, serã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. Sim
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 Sim
Content-Encoding Cabeçalho que indica o tipo de encoding (geralmente algoritmo de compressão) foi utilizado para envio da resposta Não
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 resposta 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

Cada atributo definido deverá ter um status indicando se o mesmo é obrigatório ou opcional.

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 opcionais podem ter uma restrição vinculada à 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"
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"

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 permite filtros por query ou POST. Isso é, filtros e paginação são aplicados de forma independente.

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 as próximas Fases do Open Banking, em especial a partir da Fase 2. No objeto links, serão retornadas 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, serão retornadas 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 para atender ao seguinte:

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, o participante deve 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 deseja adicionar um novo endpoint que resume as transações por um período, então este endpoint poderia 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 estiver sendo adicionado ao payload de resposta, apenas o nome do objeto precisa receber o prefixo. Qualquer atributo dentro do novo objeto pode 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 relevante para a melhor experiência do cliente.
A informação 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 e ao público em geral no exercício de atividades da instituição, não podendo ser móvel ou transitória.

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.

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.

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.

Instituição Financeira (Company)

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

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.

Segurança - Consumo

Visão geral

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

Segue, a continuação, um overview das camadas de segurança básicas para atender os contextos 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.

APIs Comuns

API de Status

GET /discovery/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
  }
}

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

Versão
1

Parâmetros

Nome Local Tipo Obrigatório Descrição

Resposta

Status Significado Descrição Schema
200 OK Sucesso ResponseDiscoveryStatusList

API de Outages

GET /discovery/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": []
      }
    ]
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/discovery/v1/outages"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

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

Versão
1

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"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki, 1270",
                "districtName": "Centro",
                "townName": "Marília",
                "countrySubDivision": "SP",
                "postCode": "17500001"
              },
              "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",
                "allowPublicAccess": true
              },
              "phones": [
                {
                  "type": "FIXO",
                  "countryCode": "55",
                  "areaCode": "14",
                  "number": "35721199"
                },
                {
                  "type": "MOVEL",
                  "countryCode": "55",
                  "areaCode": "14",
                  "number": "997865532"
                }
              ],
              "service": {
                "codes": [
                  "ABERTURA_CONTAS",
                  "RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS",
                  "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA",
                  "OPERACOES_CREDITO",
                  "CARTAO_CREDITO",
                  "OPERACOES_CAMBIO",
                  "INVESTIMENTOS",
                  "SEGUROS",
                  "OUTROS"
                ],
                "additionalInfo": "Renegociação, Previdência Privada"
              }
            }
          ]
        }
      ]
    }
  },
  "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) e Posto de Atendimento Eletrônico – PAE (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",
                "additionalInfo": "NA",
                "url": "https://empresaa1.com/internet-banking"
              },
              "service": {
                "codes": [
                  "ABERTURA_CONTA",
                  "RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS",
                  "OPERACOES_CREDITO",
                  "CARTAO_CREDITO",
                  "OPERACOES_CAMBIO",
                  "INVESTIMENTOS",
                  "SEGUROS",
                  "OUTROS"
                ],
                "additionalInfo": "Previdência Complementar"
              }
            }
          ]
        }
      ]
    }
  },
  "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_BANKING",
                "additionalInfo": "NA",
                "phones": [
                  {
                    "countryCode": "55",
                    "areaCode": "14",
                    "number": "35721199",
                    "additionalInfo": "NA"
                  },
                  {
                    "countryCode": "55",
                    "areaCode": "14",
                    "number": "997865532",
                    "additionalInfo": "NA"
                  }
                ]
              },
              "service": {
                "codes": [
                  "ABERTURA_CONTA",
                  "RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS",
                  "OPERACOES_CREDITO",
                  "CARTAO_CREDITO",
                  "OPERACOES_CAMBIO",
                  "INVESTIMENTOS",
                  "SEGUROS",
                  "OUTROS"
                ],
                "additionalInfo": "Atendimento em língua inglesa, 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"
                  },
                  "postalAddresses": [
                    {
                      "address": "Av Tasuko Ykeda, 25",
                      "districtName": "Centro",
                      "townName": "Marília",
                      "countrySubDivision": "SP",
                      "postCode": "17500001"
                    },
                    {
                      "address": "R Yroshima Takasi, 72",
                      "districtName": "Altos da Colina",
                      "townName": "Marília",
                      "countrySubDivision": "SP",
                      "postCode": "17526760"
                    },
                    {
                      "address": "Al Nasso Origami, 15, bloco A",
                      "districtName": "Centro",
                      "townName": "Marília",
                      "countrySubDivision": "SP",
                      "postCode": "17500001"
                    }
                  ],
                  "services": {
                    "codes": [
                      "RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_ABERTURA_CONTAS",
                      "REALIZACAO_RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS",
                      "RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA",
                      "EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGAMENTO",
                      "RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_CREDITO_ARRENDAMENTO_MERCANTIL",
                      "RECEBIMENTO_PAGAMENTOS_RELACIONADOS_LETRAS_CAMBIO_ACEITE_INSTITUICAO",
                      "RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_FORNECIMENTO_CARTAO_CREDITO",
                      "REALIZACAO_OPERACOES_CAMBIO"
                    ],
                    "additionalInfo": "Compra e venda de moeda em dólar americano"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "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: Agência (Branch) 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

Especificação em OAS 3.0

Download da Especificação (OAS 3.0)

API - Produtos e Serviços

Contas pessoa física

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",
          "cnpjNumbers": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "personalAccounts": [
            {
              "type": "CONTA_DEPOSITO_A_VISTA",
              "fees": [
                {
                  "priorityService": {
                    "name": "Fornecimento de extrato de um período de conta de depósitos à vista e de poupança",
                    "code": "TED_PESSOAL",
                    "chargingTriggerInfo": "Fornecimento de extrato com a movimentação de um período em guichê de caixa ou por outras formas de atendimento pessoal, tal como atendimento telefônico realizado por atendente.",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "35.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "45.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "52.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "45.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "88.00",
                      "currency": "BRL"
                    }
                  },
                  "otherService": {
                    "name": "Evento personalizado",
                    "code": "EVENTO_PERSONALIZADO",
                    "chargingTriggerInfo": "Cobrança devido a evento personalizado",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "30.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "45.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "62.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "19.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "88.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "serviceBundles": [
                {
                  "name": "Movimentação com cartão (sem cheque)",
                  "services": [
                    {
                      "code": "CADASTRO",
                      "eventLimitQuantity": "1",
                      "freeEventQuantity": "0"
                    },
                    {
                      "code": "SAQUE_TERMINAL",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "8"
                    },
                    {
                      "code": "EXTRATO_MOVIMENTO_E",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "4"
                    },
                    {
                      "code": "TRANSF_RECURSO_P",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "2"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "monthlyFee": "43.40",
                      "currency": "BRL"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "monthlyFee": "55.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "monthlyFee": "62.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "monthlyFee": "69.0",
                      "currency": "BRL"
                    }
                  ],
                  "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",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "999999"
                    },
                    {
                      "code": "Serviço 2",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "8"
                    },
                    {
                      "code": "Serviço 3",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "4"
                    },
                    {
                      "code": "Serviço 4",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "2"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "monthlyFee": "30.40",
                      "currency": "BRL"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "monthlyFee": "45.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "monthlyFee": "62.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "monthlyFee": "69.00",
                      "currency": "BRL"
                    }
                  ],
                  "minimum": {
                    "value": "33.00",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "87.00",
                    "currency": "BRL"
                  }
                }
              ],
              "openingClosingChannels": "CENTRAL_TELEFONICA",
              "additionalInfo": "NA",
              "transactionMethods": "MOVIMENTACAO_CARTAO",
              "termsConditions": {
                "minimumBalance": {
                  "value": "200.00",
                  "currency": "BRL"
                },
                "elegibilityCriteriaInfo": "https://example.com/mobile-banking",
                "closingProcessInfo": "https://example.com/mobile-banking"
              },
              "incomeRates": [
                {
                  "savingAccount": "NA",
                  "prepaidPaymentAccount": {
                    "applications": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "rate": "NA"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "rate": "NA"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "rate": "NA"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "rate": "NA"
                      }
                    ],
                    "mininumRate": "NA",
                    "maximumRate": "NA"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "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-accounts

Versão
1

Visão Geral

Obtém os dados da Conta Pessoa Física.

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 física 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 ResponsePersonalAccountList

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": [
                {
                  "service": {
                    "name": "NA",
                    "code": "NA",
                    "chargingTriggerInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "55.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "65.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "69.00  ",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "72.00",
                        "currency": "BRL"
                      }
                    ],
                    "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)",
                  "service": [
                    {
                      "code": "CADASTRO",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "999999"
                    },
                    {
                      "code": "SAQUE_TERMINAL",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "8"
                    },
                    {
                      "code": "EXTRATO_MOVIMENTO_E",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "4"
                    },
                    {
                      "code": "TRANSF_RECURSO_P",
                      "eventLimitQuantity": "999999",
                      "freeEventQuantity": "2"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "monthlyFee": "50.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "monthlyFee": "65.40",
                      "currency": "BRL"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "monthlyFee": "75.40",
                      "currency": "BRL"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "monthlyFee": "83.00",
                      "currency": "BRL"
                    }
                  ],
                  "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": "WhatsApp",
              "transactionMethods": "MOVIMENTACAO_CARTAO",
              "termsConditions": {
                "minimumBalance": {
                  "value": "500.00",
                  "currency": "BRL"
                },
                "elegibilityCriteriaInfo": "https://empresaa1.com/Accounts_elegebilityCriteria",
                "closingProcessInfo": "https://empresaa1.com/Accounts_closingProcess"
              },
              "incomeRates": [
                {
                  "savingAccount": "NA",
                  "prepaidPaymentAccount": {
                    "applications": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "rate": "NA"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "rate": "NA"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "rate": "NA"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "rate": "NA"
                      }
                    ],
                    "minimumRate": "NA",
                    "maximumRate": "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 ResponseBusinessAccountsList

Empréstimos pessoa física

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": "50685362000135",
          "name": "Empresa da Marca A",
          "urlComplementaryList": "https://example.com/mobile-banking",
          "personalLoans": [
            {
              "type": "ADIANTAMENTO_DEPOSITANTE",
              "fees": [
                {
                  "service": {
                    "name": "Adiantamento a Depositantes / Excesso Limite",
                    "code": "ADIANT. DEPOSITANTE DD/MM",
                    "chargingTriggerInfo": "Tarifa cobrada sobre saldo a descoberto em conta corrente a cada ocorrencia",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "45.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "57.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "62.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "39.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "71.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "1_QUARTIL_CLIENTES",
                    "rate": "0.0987"
                  },
                  {
                    "interval": "2_QUARTIL_CLIENTES",
                    "rate": "0.1600"
                  },
                  {
                    "interval": "3_QUARTIL_CLIENTES",
                    "rate": "0.3600"
                  },
                  {
                    "interval": "4_QUARTIL_CLIENTES",
                    "rate": "0.5890"
                  }
                ],
                "minimumRate": "0.0456",
                "maximumRate": "0.6865"
              },
              "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 física.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Empréstimos para pessoa física 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) 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 ResponsePersonalLoansList

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": "50685362000135",
          "name": "Empresa A1",
          "urlComplementaryList": "https://example.com/mobile-banking",
          "businessLoans": [
            {
              "type": "ADIANTAMENTO_DEPOSITANTE",
              "fees": [
                {
                  "service": {
                    "name": "Adiantamento a Depositantes / Excesso Limite",
                    "code": "ADIANT. DEPOSITANTE DD/MM",
                    "chargingTriggerInfo": "Tarifa cobrada sobre saldo a descoberto em conta corrente a cada ocorrencia",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "1000.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "1200.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "3072.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "7020.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "100.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "15000.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "1_QUARTIL_CLIENTES",
                    "rate": "0.0987"
                  },
                  {
                    "interval": "2_QUARTIL_CLIENTES",
                    "rate": "0.1600"
                  },
                  {
                    "interval": "3_QUARTIL_CLIENTES",
                    "rate": "0.3600"
                  },
                  {
                    "interval": "4_QUARTIL_CLIENTES",
                    "rate": "0.5890"
                  }
                ],
                "minimumRate": "0.0456",
                "maximumRate": "0.6865"
              },
              "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>/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) 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 ResponseBusinessLoansList

Financiamento Pessoa Física

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://empresaa1.com/branches-banking'",
          "personalFinancings": [
            {
              "type": "FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES",
              "fees": [
                {
                  "service": {
                    "name": "Avaliação, Reavaliação e Substituição de Bens Recebidos em Garantia",
                    "code": "AQBAM009",
                    "chargingTriggerInfo": "570.00",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "45.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "57.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "62.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "39.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "71.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "1_QUARTIL_CLIENTES",
                    "rate": "0.0987"
                  },
                  {
                    "interval": "2_QUARTIL_CLIENTES",
                    "rate": "0.1600"
                  },
                  {
                    "interval": "3_QUARTIL_CLIENTES",
                    "rate": "0.3600"
                  },
                  {
                    "interval": "4_QUARTIL_CLIENTES",
                    "rate": "0.5890"
                  }
                ],
                "minimumRate": "0.0456",
                "maximumRate": "0.6865"
              },
              "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>/personal-financings

Versão
1

Visão Geral

Obtém os dados de Financiamento para pessoa física.

Esta especificação inclui todos os itens relevantes para a Especificação de API de Financiamentos para Pessoa Física de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Financiamento (Financing), Instituição Financeira (Company), 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 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 ResponsePersonalFinancingsList

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": "50685362000135",
          "name": "Empresa A1",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "businessFinancings": [
            {
              "type": "FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES",
              "fees": [
                {
                  "service": {
                    "name": "Avaliação, Reavaliação e Substituição de Bens Recebidos em Garantia",
                    "code": "AQBAM009",
                    "chargingTriggerInfo": "570.00",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "1000.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "1200.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "3072.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "7020.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "100.00",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "15000.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "1_QUARTIL_CLIENTES",
                    "rate": "0.0987"
                  },
                  {
                    "interval": "2_QUARTIL_CLIENTES",
                    "rate": "0.1600"
                  },
                  {
                    "interval": "3_QUARTIL_CLIENTES",
                    "rate": "0.3600"
                  },
                  {
                    "interval": "4_QUARTIL_CLIENTES",
                    "rate": "0.5890"
                  }
                ],
                "minimumRate": "0.0456",
                "maximumRate": "0.6865"
              },
              "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
  }
}
No links

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) 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 ResponseBusinessFinancingsList

Antecipação de recebíveis Pessoa Física

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": [
                {
                  "service": {
                    "name": "Informar Serviço para PF",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "62.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "75.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "85.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "59.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "87.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "1_QUARTIL_CLIENTES",
                    "rate": "0.0100"
                  },
                  {
                    "interval": "2_QUARTIL_CLIENTES",
                    "rate": "0.0200"
                  },
                  {
                    "interval": "3_QUARTIL_CLIENTES",
                    "rate": "0.0390"
                  },
                  {
                    "interval": "4_QUARTIL_CLIENTES",
                    "rate": "0.0455"
                  }
                ],
                "minimumRate": "0.0015",
                "maximumRate": "0.5100"
              },
              "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>/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 Física de dados abertos.

Tags: CNPJ (CNPJ Number), Marca (Brand), Direito Creditório Descontado (Invoice Financing), Instituição Financeira (Company), 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 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 ResponsePersonalInvoiceFinancingList

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": [
                {
                  "service": {
                    "name": "Informar Serviço para PJ",
                    "code": "NA",
                    "chargingTriggerInfo": "3% do valor do contrato",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "value": "62.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "75.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "85.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "59.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "87.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "1_QUARTIL_CLIENTES",
                    "rate": "0.0100"
                  },
                  {
                    "interval": "2_QUARTIL_CLIENTES",
                    "rate": "0.0200"
                  },
                  {
                    "interval": "3_QUARTIL_CLIENTES",
                    "rate": "0.0390"
                  },
                  {
                    "interval": "4_QUARTIL_CLIENTES",
                    "rate": "0.0455"
                  }
                ],
                "minimumRate": "0.0015",
                "maximumRate": "0.5100"
              },
              "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) 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 ResponseBusinessInvoiceFinancingList

Cartão de crédito de pessoa física

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 A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-banking",
          "personalCreditCards": [
            {
              "name": "Cartão Universitário",
              "identification": {
                "product": {
                  "type": "PLATINUM",
                  "additionalInfo": "string"
                },
                "creditCard": {
                  "network": "MASTERCARD",
                  "additionalInfo": "string"
                }
              },
              "rewardsProgram": {
                "hasRewardProgram": false,
                "rewardProgramInfo": "https://example.com/mobile-banking"
              },
              "fees": [
                {
                  "name": "ANUIDADE",
                  "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_QUARTIL_CLIENTES",
                      "value": "45.40",
                      "currency": "BRL"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "value": "57.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "value": "62.00",
                      "currency": "BRL"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "value": "69.00",
                      "currency": "BRL"
                    }
                  ],
                  "minimum": {
                    "value": "39.90",
                    "currency": "BRL"
                  },
                  "maximum": {
                    "value": "71.00",
                    "currency": "BRL"
                  }
                }
              ],
              "interest": {
                "feeRate": {
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "rate": "0.0987"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "rate": "0.1600"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "rate": "0.3600"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "rate": "0.5890"
                    }
                  ],
                  "minimumRate": "0.0845",
                  "maximumRate": "0.9000"
                },
                "instalmentRate": {
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "rate": "0.0987"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "rate": "0.1600"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "rate": "0.3600"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "rate": "0.5890"
                    }
                  ],
                  "minimumRate": "0.0845",
                  "maximumRate": "0.9000"
                },
                "interestRates": [
                  {
                    "code": "SAQUE_A_CREDITO",
                    "additionalInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "rate": "0.1500"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "rate": "0.2000"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "rate": "0.3500"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "rate": "0.6800"
                      }
                    ],
                    "minimumRate": "0.0450",
                    "maximumRate": "0.7000"
                  },
                  {
                    "code": "PAGAMENTOS_CONTAS",
                    "additionalInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "rate": "0.1500"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "rate": "0.2700"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "rate": "0.4000"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "rate": "0.4100"
                      }
                    ],
                    "minimumRate": "0.0900",
                    "maximumRate": "0.5500"
                  }
                ]
              },
              "termsConditions": {
                "minimumFeeRate": "0.25",
                "additionalInfo": "string",
                "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/<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-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 física.

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) 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 ResponsePersonalCreditCardsList

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 Microempreendedor Bem-Vindo",
              "identification": {
                "product": {
                  "type": "PLATINUM",
                  "additionalInfo": "string"
                },
                "creditCard": {
                  "network": "MASTERCARD",
                  "additionalInfo": "string"
                }
              },
              "rewardsProgram": {
                "hasRewardProgram": false,
                "rewardProgramInfo": "https://example.com/mobile-banking"
              },
              "fees": [
                {
                  "service": {
                    "name": "ANUIDADE",
                    "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_QUARTIL_CLIENTES",
                        "value": "45.40",
                        "currency": "BRL"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "value": "57.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "value": "62.00",
                        "currency": "BRL"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "value": "69.00",
                        "currency": "BRL"
                      }
                    ],
                    "minimum": {
                      "value": "39.90",
                      "currency": "BRL"
                    },
                    "maximum": {
                      "value": "71.00",
                      "currency": "BRL"
                    }
                  }
                }
              ],
              "interest": {
                "feeRate": {
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "rate": "0.0987"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "rate": "0.1600"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "rate": "0.3600"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "rate": "0.5890"
                    }
                  ],
                  "minimumRate": "0.0845",
                  "maximumRate": "0.9000"
                },
                "instalmentRate": {
                  "prices": [
                    {
                      "interval": "1_QUARTIL_CLIENTES",
                      "rate": "0.0987"
                    },
                    {
                      "interval": "2_QUARTIL_CLIENTES",
                      "rate": "0.1600"
                    },
                    {
                      "interval": "3_QUARTIL_CLIENTES",
                      "rate": "0.3600"
                    },
                    {
                      "interval": "4_QUARTIL_CLIENTES",
                      "rate": "0.5890"
                    }
                  ],
                  "minimumRate": "0.0845",
                  "maximumRate": "0.9000"
                },
                "interestRates": [
                  {
                    "code": "SAQUE_A_CREDITO",
                    "additionalInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "rate": "0.1500"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "rate": "0.2000"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "rate": "0.3500"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "rate": "0.6800"
                      }
                    ],
                    "minimumRate": "0.0450",
                    "maximumRate": "0.7000"
                  },
                  {
                    "code": "PAGAMENTOS_CONTAS",
                    "additionalInfo": "NA",
                    "prices": [
                      {
                        "interval": "1_QUARTIL_CLIENTES",
                        "rate": "0.1500"
                      },
                      {
                        "interval": "2_QUARTIL_CLIENTES",
                        "rate": "0.2700"
                      },
                      {
                        "interval": "3_QUARTIL_CLIENTES",
                        "rate": "0.4000"
                      },
                      {
                        "interval": "4_QUARTIL_CLIENTES",
                        "rate": "0.4100"
                      }
                    ],
                    "minimumRate": "0.0900",
                    "maximumRate": "0.5500"
                  }
                ]
              },
              "termsConditions": {
                "minimumFeeRate": "0.25",
                "additionalInfo": "string",
                "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/<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-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) 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 ResponseBusinessCreditCardsList

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 dos produtos e serviços ofertados, as instituições devem compartilhar uma distribuição de frequência relativa dos valores cobrados dos clientes.

Desta forma, cada instituição deve, no momento de compartilhamento, ordenar sua base em ordem crescente de valores cobrados para um determinado produto/serviço, segmentá-la em quatro faixas com mesmo número de clientes (i.e. 4 quartis de clientes) e divulgar 6 valores:

Devem ser utilizados no cálculo os valores devidos de tarifas e os valores cobrados de taxas de juros remuneratórias disponíveis nas bases de cliente no mês de referência (M-1).

Caso haja mais de 1 operação 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.

Por fim, para taxas de juros remuneratórias, os valores a serem compartilhados/divulgados serão as taxas efetivas, ajustadas pelos indexadores associados, das concessões no mês de referência (M-1).

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
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "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

Swagger

Download do Swagger (OAS 3.0)

Schemas

ResponseBranchesList

{
  "data": {
    "brand": [
      {
        "name": "string",
        "companies": [
          {
            "name": "string",
            "cnpjNumber": "string",
            "urlComplementaryList": "string",
            "branches": [
              {
                "identification": {
                  "type": "string",
                  "code": "string",
                  "checkDigit": "string",
                  "name": "string"
                },
                "postalAddress": {
                  "address": "string",
                  "districtName": "string",
                  "townName": "string",
                  "countrySubDivision": "string",
                  "postCode": "string"
                },
                "availability": {
                  "standards": [
                    {
                      "weekday": "string",
                      "openingTime": "string",
                      "closingTime": "string"
                    }
                  ],
                  "exception": "string",
                  "allowPublicAccess": "string"
                },
                "phones": [
                  {
                    "type": "string",
                    "countryCode" : "string",
                    "areaCode": "string",
                    "number": "string"
                  }
                ],
                "service": {
                  "codes": [
                    "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 Lista das organizações titulares das dependências.
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"
          },
          "postalAddress": {
            "address": "string",
            "districtName": "string",
            "townName": "string",
            "countrySubDivision": "string",
            "postCode": "string"
          },
          "availability": {
            "standards": [
              {
                "weekday": "string",
                "openingTime": "string",
                "closingTime": "string"
              }
            ],
            "exception": "string",
            "allowPublicAccess": "string"
          },
          "phones": [
            {
              "type": "string",
              "countryCode" : "string",
              "areaCode": "string",
              "number": "string"
            }
          ],
          "service": {
            "codes": [
              "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 [BranchesCompanies] Sim Lista de instituições pertencentes à marca.

BranchesCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "branches": [
    {
      "identification": {
        "type": "string",
        "code": "string",
        "checkDigit": "string",
        "name": "string"
      },
      "postalAddress": {
        "address": "string",
        "districtName": "string",
        "townName": "string",
        "countrySubDivision": "string",
        "postCode": "string"
      },
      "availability": {
        "standards": [
          {
            "weekday": "string",
            "openingTime": "string",
            "closingTime": "string"
          }
        ],
        "exception": "string",
        "allowPublicAccess": "string"
      },
      "phones": [
        {
          "type": "string",
          "countryCode" : "string",
          "areaCode": "string",
          "number": "string"
        }
      ],
      "service": {
        "codes": [
          "string"
        ],
        "additionalInfo": "string"
      }
    }
  ]
}
Nome Tipo Obrigatório Descrição
name string Sim Nome da Instituição, pertencente à marca, responsável pela Dependência.
cnpjNumber string Sim CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
urlComplementaryList string Não URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber
branches [Branch] Sim Lista de dependências próprias da instituição.

Branch

{
  "identification": {
    "type": "string",
    "code": "string",
    "checkDigit": "string",
    "name": "string"
  },
  "postalAddress": {
    "address": "string",
    "districtName": "string",
    "townName": "string",
    "countrySubDivision": "string",
    "postCode": "string"
  },
  "availability": {
    "standards": [
      {
        "weekday": "string",
        "openingTime": "string",
        "closingTime": "string"
      }
    ],
    "exception": "string",
    "allowPublicAccess": "string"
  },
  "phones": [
    {
      "type": "string",
      "countryCode" : "string",
      "areaCode": "string",
      "number": "string"
    }
  ],
  "service": {
    "codes": [
      "string"
    ],
    "additionalInfo": "string"
  }
}
Nome Tipo Obrigatório Descriçã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 Não Lista de telefones para contato com a dependência.
service BranchServices Sim Serviços fornecidos na dependência.

BranchIdentification

{
  "type": "string",
  "code": "string",
  "checkDigit": "string",
  "name": "string"
}
Nome Tipo Obrigatório Descrição
type Enum BranchIdentificationType Sim Tipo de dependência própria.
code string Sim Código identificador da dependência.
checkDigit string Sim Dígito verificador do código da dependência.
name string Sim Nome da dependência bancária.

Enum BranchIdentificationType

Propriedade Código Definição
type AGENCIA Agências.
type POSTO_ATENDIMENTO Postos de atendimento.
type POSTO_ATENDIMENTO_ELETRONICO Postos de atendimento eletrônico.

BranchPostalAddress

{
  "address": "string",
  "districtName": "string",
  "townName": "string",
  "countrySubDivision": "string",
  "postCode": "string"
}
Nome Tipo Obrigatório Descrição
address string Sim Informação referente ao endereço da Depêndência Bancária informada: 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

BranchAvailability

{
  "standards": [
    {
      "weekday": "string",
      "openingTime": "string",
      "closingTime": "string"
    }
  ],
  "exception": "string",
  "allowPublicAccess": "string"
}
Nome Tipo Obrigatório Descrição
standards Array Sim Lista com os dias da semana.
weekday [Enum WeekDay] Sim Dia da semana.
openingTime [TimeString] Sim Horário padrão de início de atendimento da Dependência.
closingTime [TimeString] Sim Horário padrão de encerramento de atendimento da Dependência.
exception string Não Informações sobre as exceções de abertura.
allowPublicAccess string Sim Define se a dependência possui acesso ao público. True ou False.

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",
  "countryCode" : "string",
  "areaCode": "string",
  "number": "string"
}
Nome Tipo Obrigatório Descrição
type Enum BranchPhoneType Sim Tipo de telefone.
countryCode string Sim DDI.
areaCode string Sim DDD.
number string Sim Número do telefone.

Enum BranchPhoneType

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

BranchServices

{
  "codes": [
    "string"
  ],
  "additionalInfo": "string"
}
Nome Tipo Obrigatório Descrição
codes [Enum BranchServicesCodes] Sim Lista de serviços prestados.
additionalInfo string Não Campo de texto livre para descrever mais sobre os serviços.

Enum BranchServicesCodes

Propriedade Código Definição
codes ABERTURA_CONTAS Abertura de contas.
codes RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS Recebimentos, pagamentos e transferências eletrônicas.
codes RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA Recebimentos e pagamentos de qualquer natureza.
codes OPERACOES_CREDITO Operações de crédito.
codes CARTAO_CREDITO Cartão de crédito.
codes OPERACOES_CAMBIO Operações de câmbio.
codes INVESTIMENTOS Investimentos.
codes SEGUROS Seguros.
codes FALAR_ATENDENTE Falar com atendente.
codes OUTROS Outros.

ResponseElectronicChannelsList

{
  "data": {
    "brand": [
      {
        "name": "string",
        "companies": [
          {
            "name": "string",
            "cnpjNumber": "string",
            "urlComplementaryList": "string",
            "electronicChannels": [
              {
                "identification": {
                  "type": "string",
                  "additionalInfo": "string",
                  "url": "string"
                },
                "service": {
                  "codes": [
                    "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 Lista das organizações titulares das dependências.
links [LinksPaginated] Sim
meta MetaPaginated Sim

ElectronicChannelsBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "electronicChannels": [
        {
          "identification": {
            "type": "string",
            "additionalInfo": "string",
            "url": "string"
          },
          "service": {
            "codes": [
              "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",
        "url": "string"
      },
      "service": {
        "codes": [
          "string"
        ],
        "additionalInfo": "string"
      }
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à Marca, responsável pelos Canais de Atendimento Eletrônico (titular). p.ex. 'Empresa da Organização A'.
cnpjNumber string Sim CNPJ da instituição responsável pelo canal de atendimento - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
urlComplementaryList string Não URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber.
electronicChannels [ElectronicChannels] Sim Lista de canais de atendimento eletrônico.

ElectronicChannels

{
  "identification": {
    "type": "string",
    "additionalInfo": "string",
    "url": "string"
  },
  "service": {
    "codes": [
      "string"
    ],
    "additionalInfo": "string"
  }
}
Nome Tipo Obrigatório Definição Restrições
identification ElectronicChannelsIdentification Sim
services ElectronicChannelsServices Sim Informações sobre os serviços prestados.

ElectronicChannelsIdentification

{
  "type": "string",
  "additionalInfo": "string",
  "url": "string"
}
Nome Tipo Obrigatório Definição Restrições
type Enum ElectronicChannelsType Sim Tipo de canal de atendimento. O Tipo de Canal determina o Tipo de Acesso a ele relacionado: URL para acesso ao internet banking, URL para aquisição do app, URL da central,URL do SAC, URL da ouvidoria, URL para chat.
additionalInfo string Não Campo de texto livre para descrever quando o tipo de canal de atendimento for Outros Só será preenchido quando o tipo de canal de atendimento for Outros .
url string Não Endereço eletrônico de acesso ao canal.

Enum ElectronicChannelsType

Propriedade Código Definição
type INTERNET_BANKING Internet banking.
type MOBILE_BANKING Mobile banking.
type CHAT Chat.
type OUTROS Outros.

ElectronicChannelsServices

Nome Tipo Obrigatório Definição
codes [Enum ElectronicChannelsServicesCodes] Sim Lista com a lista de serviços prestados pelo canal.
additionalInfo string Não Descrição adicional sobre os serviços prestados.

Enum ElectronicChannelsServicesCodes

Propriedade Código Definição
codes ABERTURA_CONTAS Abertura de contas.
codes RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS Recebimentos, pagamentos e transferências eletrônicas.
codes OPERACOES_CREDITO Operações de crédito.
codes CARTAO_CREDITO Cartão de crédito.
codes OPERACOES_CAMBIO Operações de câmbio.
codes INVESTIMENTOS Investimentos.
codes SEGUROS Seguros.
codes ATENDIMENTO_DEMANDAS_CLIENTES Atendimento de demandas a clientes.
codes OUTROS Outros.

ResponsePhoneChannelsList

{
  "data": {
    "brand": [
      {
        "name": "string",
        "companies": [
          {
            "name": "string",
            "cnpjNumber": "string",
            "urlComplementaryList": "string",
            "phoneChannels": [
              {
                "identification": {
                  "type": "string",
                  "additionalInfo": "string",
                  "phones": [
                    {
                      "countryCode": "string",
                      "areaCode": "string",
                      "number": "string",
                      "additionalInfo": "string"
                    }
                  ]
                },
                "services": {
                  "codes": [
                    "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 [PhoneChannelsBrand] Sim Lista das organizações titulares das dependências.
links [LinksPaginated] Sim
meta MetaPaginated Sim

PhoneChannelsBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "phoneChannels": [
        {
          "identification": {
            "type": "string",
            "additionalInfo": "string",
            "phones": [
              {
                "countryCode": "string",
                "areaCode": "string",
                "number": "string",
                "additionalInfo": "string"
              }
            ]
          },
          "services": {
            "codes": [
              "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 [PhoneChannelsCompanies] Sim Lista de instituições pertencentes à marca.

PhoneChannelsCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "phoneChannels": [
    {
      "identification": {
        "type": "string",
        "additionalInfo": "string",
        "phones": [
          {
            "countryCode": "string",
            "areaCode": "string",
            "number": "string",
            "additionalInfo": "string"
          }
        ]
      },
      "services": {
        "codes": [
          "string"
        ],
        "additionalInfo": "string"
      }
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à organização, responsável pelo Canal Telefônico. Ex. 'Empresa da Organização A'.
cnpjNumber string Sim CNPJ da instituição responsável pelo canal de atendimento telefônico - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
urlComplementaryList string Não URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber
phoneChannels [PhoneChannels] Sim Lista de canais de atendimento telefônico.

PhoneChannels

{
  "identification": {
    "type": "string",
    "additionalInfo": "string",
    "phones": [
      {
        "countryCode": "string",
        "areaCode": "string",
        "number": "string",
        "additionalInfo": "string"
      }
    ]
  },
  "services": {
    "codes": [
      "string"
    ],
    "additionalInfo": "string"
  }
}
Nome Tipo Obrigatório Definição Restrições
identification PhoneChannelsIdentification Sim
services PhoneChannelsServices Sim Informações sobre os serviços prestados.

PhoneChannelsIdentification

{
  "type": "string",
  "additionalInfo": "string",
  "phones": [
    {
      "countryCode": "string",
      "areaCode": "string",
      "number": "string",
      "additionalInfo": "string"
    }
  ],
}
Nome Tipo Obrigatório Definição Restrições
type Enum PhoneChannelsType Sim Tipo de canal telefônico de atendimento. O Tipo de Canal determina o Tipo de Acesso a ele relacionado: telefone da central, telefone do SAC, telefone da ouvidoria.
additionalInfo string Não Campo de texto livre para descrever quando o tipo de canal de atendimento for Outros Só será preenchido quando o tipo de canal de atendimento for Outros
phones [PhoneChannelsPhones]] Não Telefones de contato com o canal de atendimento.

Enum PhoneChannelsType

Propriedade Código Definição
type CENTRAL_TELEFONICA_BANKING Central telefônica banking.
type SAC SAC.
type OUVIDORIA Ouvidoria.
type OUTROS Outros.

PhoneChannelsPhones

Nome Tipo Obrigatório Definição
countryCode string Não DDI.
areaCode string Não DDD.
number string Sim Telefone para contato com o canal.
additionalInfo string Não Mensagem complementar necessária para o agrupamento da identificação do telefone.

PhoneChannelsServices

Nome Tipo Obrigatório Definição
codes [Enum PhoneChannelsServicesCodes] Sim Lista com a lista de serviços prestados pelo canal.
additionalInfo string Não Descrição adicional sobre os serviços prestados.

Enum PhoneChannelsServicesCodes

Propriedade Código Definição
codes ABERTURA_CONTAS Abertura de contas.
codes RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIAS_ELETRONICAS Recebimentos, pagamentos e transferências eletrônicas.
codes OPERACOES_CREDITO Operações de crédito.
codes CARTAO_CREDITO Cartão de crédito.
codes OPERACOES_CAMBIO Operações de câmbio.
codes INVESTIMENTOS Investimentos.
codes SEGUROS Seguros.
codes RECLAMACOES Reclamações.
codes CANCELAMENTO Cancelamento.
codes INFORMACOES Informacões.
codes OUTROS Outros.

ResponseBankingAgentsList

{
  "data": {
    "brand": [
      {
        "name": "string",
        "companies": [
          {
            "name": "string",
            "cnpjNumber": "string",
            "contractors": [
              {
                "name": "string",
                "cnpjNumber": "string",
                "bankingAgents": [
                  {
                    "identification": {
                      "corporationName": "string",
                      "groupName": "string",
                      "cnpjNumber": "string"
                    },
                    "postalAddresses": [
                      {
                        "address": "string",
                        "districtName": "string",
                        "townName": "string",
                        "countrySubDivision": "string",
                        "postCode": "string"
                      }
                    ],
                    "services": {
                      "codes": [
                        "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 Lista das organizações titulares das dependência.
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"
              },
              "postalAddresses": [
                {
                  "address": "string",
                  "districtName": "string",
                  "townName": "string",
                  "countrySubDivision": "string",
                  "postCode": "string"
                }
              ],
              "services": {
                "codes": [
                  "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"
          },
          "postalAddresses": [
            {
              "address": "string",
              "districtName": "string",
              "townName": "string",
              "countrySubDivision": "string",
              "postCode": "string"
            }
          ],
          "services": {
            "codes": [
              "string"
            ],
            "additionalInfo": "string"
          }
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definiçã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 do 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 Lista de contratantes.

BankingAgentsContractor

{
  "name": "string",
  "cnpjNumber": "string",
  "bankingAgents": [
    {
      "identification": {
        "corporationName": "string",
        "groupName": "string",
        "cnpjNumber": "string"
      },
      "postalAddresses": [
        {
          "address": "string",
          "districtName": "string",
          "townName": "string",
          "countrySubDivision": "string",
          "postCode": "string"
        }
      ],
      "services": {
        "codes": [
          "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"
  },
  "postalAddresses": [
    {
      "address": "string",
      "districtName": "string",
      "townName": "string",
      "countrySubDivision": "string",
      "postCode": "string"
    }
  ],
  "services": {
    "codes": [
      "string"
    ],
    "additionalInfo": "string"
  }
}
Nome Tipo Obrigatório Descrição
identification BankingAgentsIdentification Sim Dados de identificação do correspondente.
postalAddresses BankingAgentsPostalAddress Sim Endereço do correspondente.
services BankingAgentsServices Sim Serviços fornecidos pelo correspondente.

BankingAgentsIdentification

{
  "corporationName": "string",
  "groupName": "string",
  "cnpjNumber": "string"
}
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.

BankingAgentsPostalAddress

{
  "address": "string",
  "districtName": "string",
  "townName": "string",
  "countrySubDivision": "string",
  "postCode": "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.

BankingAgentsServices

{
  "codes": [
    "string"
  ],
  "additionalInfo": "string"
}
Nome Tipo Obrigatório Descrição
codes [Enum BankingAgentsServicesCodes] Sim Lista de serviços prestados.
additionalInfo string Não Detalhes adicionais sobre os serviços prestados.

Enum BankingAgentsServicesCodes

Propriedade Código Definição
codes RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_ABERTURA_CONTAS Recepção e encaminhamento de propostas de abertura de contas.
codes REALIZACAO_RECEBIMENTOS_PAGAMENTOS_TRANSFERENCIA_ELETRONICAS Realização de recebimentos, pagamentos e transferências eletrônicas.
codes RECEBIMENTOS_PAGAMENTOS_QUALQUER_NATUREZA Recebimentos e pagamentos de qualquer natureza.
codes EXECUCAO_ATIVA_PASSIVA_ORDENS_PAGAMENTO Execução ativa e passiva de ordens de pagamento.
codes RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_CREDITO_ARRENDAMENTO_MERCANTIL Recepção e encaminhamento de propostas de operações de crédito e de arrendamento mercantil.
codes RECEBIMENTO_PAGAMENTOS_RELACIONADOS_LETRAS_CAMBIO_ACEITE_INSTITUICAO Recebimento e pagamentos relacionados a letras de câmbio de aceite da instituição.
codes RECEPCAO_ENCAMINHAMENTO_PROPOSTAS_FORNECEIMENTO_CARTAO_CREDITO Recepção e encaminhamento de propostas de fornecimento de cartões de crédito.
codes REALIZACAO_OPERACOES_CAMBIO Realização de operações de câmbio.

ResponseBusinessAccountsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "businessAccounts": [
            {
              "type": "string",
              "fees": [
                {
                  "service": {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "serviceBundles": [
                {
                  "name": "string",
                  "service": [
                    {
                      "code": "string",
                      "eventLimitQuantity": "string",
                      "freeEventQuantity": "string"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "string",
                      "monthlyFee": "string",
                      "currency": "string"
                    }
                  ],
                  "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                  "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
                }
              ],
              "openingClosingChannels": [
                "string"
              ],
              "additionalInfo": "string",
              "transactionMethods": "string",
              "termsConditions": {
                "minimumBalance": {
                  "value": "string",
                  "currency": "string"
                },
                "elegibilityCriteriaInfo": "string",
                "closingProcessInfo": "string"
              },
              "incomeRates": [{
                "savingAccount": "string",
                "prepaidPaymentAccount": {
                  "applications": [
                    {
                      "interval": "string",
                      "rate": "string"
                    }
                  ],
                  "minimumRate": "string",
                  "maximumRate": "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 BusinessAccountBrand Sim Lista das organizações responsáveis pelas contas.
links LinksPaginated Sim
meta MetaPaginated Sim

BusinessAccountBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "businessAccounts": [
        {
          "type": "string",
          "fees": [
            {
              "service": {
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                  "value": "string",
                  "currency": "string"
                },
                "maximum": {
                  "value": "string",
                  "currency": "string"
                }
              }
            }
          ],
          "serviceBundles": [
            {
              "name": "string",
              "service": [
                {
                  "code": "string",
                  "eventLimitQuantity": "string",
                  "freeEventQuantity": "string"
                }
              ],
              "prices": [
                {
                  "interval": "string",
                  "monthlyFee": "string",
                  "currency": "string"
                }
              ],
              "minimum": {
                "value": "string",
                "currency": "string"
              },
              "maximum": {
                "value": "string",
                "currency": "string"
              }
            }
          ],
          "openingClosingChannels": [
            "string"
          ],
          "additionalInfo": "string",
          "transactionMethods": "string",
          "termsConditions": {
            "minimumBalance": {
              "value": "string",
              "currency": "string"
            },
            "elegibilityCriteriaInfo": "string",
            "closingProcessInfo": "string"
          },
          "incomeRates": [{
            "savingAccount": "string",
            "prepaidPaymentAccount": {
              "applications": [
                {
                  "interval": "string",
                  "rate": "string"
                }
              ],
              "minimumRate": "string",
              "maximumRate": "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 BusinessAccountCompany Sim Lista de instituições pertencentes à marca.

BusinessAccountCompany

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "businessAccounts": [
    {
      "type": "string",
      "fees": [
        {
          "service": {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "serviceBundles": [
        {
          "name": "string",
          "service": [
            {
              "code": "string",
              "eventLimitQuantity": "string",
              "freeEventQuantity": "string"
            }
          ],
          "prices": [
            {
              "interval": "string",
              "monthlyFee": "string",
              "currency": "string"
            }
          ],
          "minimum": {
            "value": "string",
            "currency": "string"
          },
          "maximum": {
            "value": "string",
            "currency": "string"
          }
        }
      ],
      "openingClosingChannels": [
        "string"
      ],
      "additionalInfo": "string",
      "transactionMethods": "string",
      "termsConditions": {
        "minimumBalance": {
          "value": "string",
          "currency": "string"
        },
        "elegibilityCriteriaInfo": "string",
        "closingProcessInfo": "string"
      },
      "incomeRates": [{
        "savingAccount": "string",
        "prepaidPaymentAccount": {
          "applications": [
            {
              "interval": "string",
              "rate": "string"
            }
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        }
      }]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização dos tipos de contas de pessoas jurídicas consultadas.
cnpjNumber string Sim O responsável pela comercialização das modalidades de Contas para Pessoas Jurídicas consultadas.
urlComplementaryList string Sim 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.
businessAccounts BusinessAccount Sim Lista de contas pessoa jurídica.

BusinessAccount

{
  "type": "string",
  "fees": [
    {
      "service": {
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "serviceBundles": [
    {
      "name": "string",
      "service": [
        {
          "code": "string",
          "eventLimitQuantity": "string",
          "freeEventQuantity": "string"
        }
      ],
      "prices": [
        {
          "interval": "string",
          "monthlyFee": "string",
          "currency": "string"
        }
      ],
      "minimum": {
        "value": "string",
        "currency": "string"
      },
      "maximum": {
        "value": "string",
        "currency": "string"
      }
    }
  ],
  "openingClosingChannels": [
    "string"
  ],
  "additionalInfo": "string",
  "transactionMethods": "string",
  "termsConditions": {
    "minimumBalance": {
      "value": "string",
      "currency": "string"
    },
    "elegibilityCriteriaInfo": "string",
    "closingProcessInfo": "string"
  },
  "incomeRates": [{
    "savingAccount": "string",
    "prepaidPaymentAccount": {
      "applications": [
        {
          "interval": "string",
          "rate": "string"
        }
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    }
  }]
}
Nome Tipo Obrigatório Descrição
type Enum TypeBusinessAccount Sim Tipos de contas ofertadas para pessoas jurídicas, conforme Resolução 3.919 do Banco Central do Brasil.
fees FeesBusinessAccount Sim Lista Tarifas cobradas.
serviceBundles ServiceBundleBusinessAccount] Sim Nome dos pacotes de serviços.
openingClosingChannels Enum BusinessAccountOpeningClosingChannel Sim Canais disponíveis para abertura e encerramento de contas.
additionalInfo string Sim Texto livre para complementar informação relativa ao Canal disponível.
transactionMethods Enum BusinessAccountTransactionMethod Sim Lista de formas de movimentação possíveis para a conta.
termsConditions TermConditionsBusinessAccount Sim Termos e condições contratuais.
incomeRates IncomeRateBusinessAccount Sim Valores dos percentuais de taxas.

Enum TypeBusinessAccount

Propriedade Valor Definição
type CONTA_CORRENTE Conta corrente - é o tipo mais comum. Nela, o dinheiro fica à sua disposição para ser sacado a qualquer momento. Essa conta não gera rendimentos para o depositante
type CONTA_POUPANCA Conta poupança - foi criada para estimular as pessoas a pouparem. O dinheiro que ficar na conta por trinta dias passa a gerar rendimentos, com isenção de imposto de renda para quem declara. Ou seja, o dinheiro “cresce” (rende) enquanto ficar guardado na conta. Cada depósito terá rendimentos de mês em mês, sempre no dia do mês em que o dinheiro tiver sido depositado
type CONTA_PAGAMENTO_PRE_PAGA Conta de pagamento pré-paga: destinada à execução de transações de pagamento em moeda eletrônica realizadas com base em fundos denominados em reais previamente aportados

Enum BusinessAccountOpeningClosingChannel

Propriedade Valor Definição
openingClosingChannels DEPENDENCIAS_PROPRIAS Dependências próprias.
openingClosingChannels CORRESPONDENTES_BANCARIOS Correspondentes bancários.
openingClosingChannels INTERNET_BANKING Internet banking.
openingClosingChannels MOBILE_BANKING Mobile banking.
openingClosingChannels CENTRAL_TELEFONICA Central telefônica.
openingClosingChannels CHAT Chat.
openingClosingChannels OUTROS Outros (p.ex. website/appps de terceiros).

Enum BusinessAccountTransactionMethod

Propriedade Valor Definição
transactionMethods MOVIMENTACAO_ELETRONICA Movimentação eletrônica.
transactionMethods MOVIMENTACAO_CHEQUE Movimentação com cheque.
transactionMethods MOVIMENTACAO_CARTAO Movimentação com cartão.
transactionMethods MOVIMENTACAO_PRESENCIAL Movimentação presencial.

FeesBusinessAccount

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
      "value": "string",
      "currency": "string"
    },
    "maximum": {
      "value": "string",
      "currency": "string"
    }
  }
}
Nome Tipo Obrigatório Descrição
service ServiceBusinessAccount Sim Tarifas de serviços da conta.

ServiceBusinessAccount

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "prices": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
    "value": "string",
    "currency": "string"
  },
  "maximum": {
    "value": "string",
    "currency": "string"
  }
}
Nome Tipo Obrigatório Descrição
name string Sim Nome atribuído a Outros Serviços disponíveis para os tipos de contas.
code string Não Sigla de identificação de Outros Serviços que incidem sobre os tipos de contas.
chargingTriggerInfo string Sim Outros fatos geradores de cobrança referentes aos Outros Serviços que incidem sobre as contas comercializadas.
prices [Price] Sim Valor da tarifa cobrada referente aos Outros Serviços.
minimum [MinimumPrice] Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência.
maximum [MaximumPrice] Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência.

ServiceBundleBusinessAccount

{
  "name": "string",
  "service": [
    {
      "code": "string",
      "eventLimitQuantity": "string",
      "freeEventQuantity": "string",
      "price": {
        "interval": "string",
        "value": "string",
        "currency": "string"
      },
      "minimum": {
            "value": "string",
            "currency": "string"
          },
      "maximum": {
          "value": "string",
          "currency": "string"
        },
    }
  ],
  "price": {
    "interval": "string",
    "monthlyFee": "string",
    "currency": "string"
  },
  "minimum": {
        "value": "string",
        "currency": "string"
      },
  "maximum": {
      "value": "string",
      "currency": "string"
    },
}
Nome Tipo Obrigatório Descrição
name string Sim Nome do conjunto de serviços.
services ServiceBusinessAccount Sim Lista de serviços.
prices ServiceBundleBusinessAccountPrice Sim Valor mensal da tarifa referente ao Pacote de Serviços
minimum MinimumPrice Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência.
maximum MaximumPrice Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência.

ServiceBusinessAccount

{
  "code": "string",
  "eventLimitQuantity": "string",
  "freeEventQuantity": "string",
  "price": {
    "interval": "string",
    "value": "string",
    "currency": "string"
  },
  "minimum": {
        "value": "string",
        "currency": "string"
    },
  "maximum": {
      "value": "string",
      "currency": "string"
    },
}
Nome Tipo Obrigatório Descrição
code string Sim Código que identifica o Serviço que compõe o Pacote de Serviços.
eventLimitQuantity string Sim Quantidade de eventos previstos no Pacote de Serviços.
freeEventQuantity string Sim Quantidade de eventos previstos no Pacote de Serviços com isenção de Tarifa.
prices PriceServiceBusinessAccount Sim Indica o tipo de valor da tarifa do serviço que compõe o Pacote de Serviços.
minimum MinimumPrice Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência.
maximum MaximumPrice Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência.

PriceServiceBusinessAccount

{
  "interval": "string",
  "value": "string",
  "currency": "string"
}
Nome Tipo Obrigatório Descrição
interval string Sim Faixas de valor referentes a tarifa do Serviço Prioritário informada: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes.
value string Sim Valor da mediana da tarifa cobrada, relativa ao Serviço Prioritário, para o tipo de faixa informada.
currency string Sim Moeda referente ao valor máximo da tarifa, segundo modelo ISO-4217.

ServiceBundleBusinessAccountPrice

{
  "interval": "string",
  "monthlyFee": "string",
  "currency": "string"
}
Nome Tipo Obrigatório Descrição
interval string Sim Faixas de valor referentes ao Serviço que compõe o Pacote de Serviços informado:: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes.
monthlyFee string Sim Valor da mediana da tarifa mensal referente ao Pacote de Serviços.
currency MinimumPrice Sim Moeda referente ao valor do Pacote de serviços, segundo modelo ISO-4217.

TermConditionBusinessAccount

{
  "minimumBalance": "string",
  "elegibilityCriteriaInfo": "string",
  "closingProcessInfo": "string"
}
Nome Tipo Obrigatório Descrição
minimumBalance string Sim Saldo mínimo exigido nos Termos e condições contratuais, que regem as contas comercializadas.
closingProcessInfo string Sim Procedimentos de encerramento para o tipo de conta tratado.

IncomeRateBusinessAccount

{
  "savingAccount": "string",
  "prepaidPaymentAccount": {
    "applications": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  }
}
Nome Tipo Obrigatório Descrição
savingAccount string Sim Descrição da Remuneração especificamente para Conta de Poupança. Deve ser preenchida com a determinação legal vigente.
prepaidPaymentAccount PrepaidPaymentIncomeRateBusinessAccount Sim Taxa de remuneração para conta do tipo CONTA_PAGAMENTO_PRE_PAGA

PrepaidPaymentIncomeRateBusinessAccount

{
  "applications": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Descrição
applications Price Sim Identifica o período referente ao percentual de taxa de remuneração efetivamente aplicada no intervalo informado.
minimumRate String Sim Percentual mínimo referente à taxa de remuneração efetivamente aplicada no mês de referência.
maximumRate String Sim Percentual máximo referente à taxa de remuneração efetivamente aplicada no mês de referência.

ResponsePersonalAccountList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "personalAccounts": [
            {
              "type": "string",
              "fees": {
                "priorityService":
                  {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "price": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                        "value": "string",
                        "currency": "string"
                      },
                    "maximum": {
                        "value": "string",
                        "currency": "string"
                      }
                  },
                "otherService": {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                        "value": "string",
                        "currency": "string"
                      },
                    "maximum": {
                        "value": "string",
                        "currency": "string"
                      }
                  }
              },
              "serviceBundles": [
                {
                  "name": "string",
                  "service": [
                    {
                      "code": "string",
                      "eventLimitQuantity": "string",
                      "freeEventQuantity": "string"
                    }
                  ],
                  "prices": [
                    {
                      "interval": "string",
                      "monthlyFee": "string",
                      "currency": "string"
                    }
                  ],
                  "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                  "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
                }
              ],
              "openingClosingChannels": "string",
              "additionalInfo":"string",
              "transactionMethods": "string",
              "termsConditions": {
              "minimumBalance": {
                   "value": "string",
                   "currency": "string"

                },
                "elegibilityCriteriaInfo": "string",
                "closingProcessInfo": "string"
              },
              "incomeRates": [{
                "savingAccount": "string",
                "prePaidPaymentAccount": {
                    "applications":{
                      "interval":"string",
                      "rate":"string"
                    },
                    "minimumRate": "string",
                    "maxiumRate": "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 [PersonalAccountBrand] Sim Lista das organizações responsáveis pelas contas.
links [LinksPaginated] Sim
meta MetaPaginated Sim

PersonalAccountBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "personalAccounts": [
        {
          "type": "string",
          "fees": {
            "priorityService":
              {
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "price": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
              },
            "otherService": {
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
              }
          },
          "serviceBundles": [
            {
              "name": "string",
              "service": [
                {
                  "code": "string",
                  "eventLimitQuantity": "string",
                  "freeEventQuantity": "string"
                }
              ],
              "prices": [
                {
                  "interval": "string",
                  "monthlyFee": "string",
                  "currency": "string"
                }
              ],
              "minimum": {
                "value": "string",
                "currency": "string"
              },
              "maximum": {
                "value": "string",
                "currency": "string"
              }
            }
          ],
          "openingClosingChannels": "string",
          "additionalInfo":"string",
          "transactionMethods": "string",
          "termsConditions": {
          "minimumBalance": {
                "value": "string",
                "currency": "string"

            },
            "elegibilityCriteriaInfo": "string",
            "closingProcessInfo": "string"
          },
          "incomeRates": [{
            "savingAccount": "string",
            "prePaidPaymentAccount": {
                "applications":{
                  "interval":"string",
                  "rate":"string"
                },
                "minimumRate": "string",
                "maxiumRate": "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 PersonalAccountCompany Sim Lista de instituições pertencentes à marca.

PersonalAccountCompany

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "personalAccounts": [
    {
      "type": "string",
      "fees": {
        "priorityService":
          {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "price": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
                "value": "string",
                "currency": "string"
              },
            "maximum": {
                "value": "string",
                "currency": "string"
              }
          },
        "otherService": {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
                "value": "string",
                "currency": "string"
              },
            "maximum": {
                "value": "string",
                "currency": "string"
              }
          }
      },
      "serviceBundles": [
        {
          "name": "string",
          "service": [
            {
              "code": "string",
              "eventLimitQuantity": "string",
              "freeEventQuantity": "string"
            }
          ],
          "prices": [
            {
              "interval": "string",
              "monthlyFee": "string",
              "currency": "string"
            }
          ],
          "minimum": {
            "value": "string",
            "currency": "string"
          },
          "maximum": {
            "value": "string",
            "currency": "string"
          }
        }
      ],
      "openingClosingChannels": "string",
      "additionalInfo":"string",
      "transactionMethods": "string",
      "termsConditions": {
      "minimumBalance": {
            "value": "string",
            "currency": "string"

        },
        "elegibilityCriteriaInfo": "string",
        "closingProcessInfo": "string"
      },
      "incomeRates": [{
        "savingAccount": "string",
        "prePaidPaymentAccount": {
            "applications":{
              "interval":"string",
              "rate":"string"
            },
            "minimumRate": "string",
            "maxiumRate": "string"
        }
      }]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização dos tipos de contas de pessoas física consultadas.
cnpjNumber string Sim O responsável pela comercialização das modalidades de Contas para Pessoas Física consultadas.
urlComplementaryList string Sim 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.
PersonalAccounts PersonalAccount Sim Lista de contas pessoa física.

PersonalAccount

{
  "type": "string",
  "fees": {
    "priorityService": {
      "name": "string",
      "code": "string",
      "chargingTriggerInfo": "string",
      "price": [
        {
          "interval": "string",
          "value": "string",
          "currency": "string"
        }
      ],
      "minimum": {
          "value": "string",
          "currency": "string"
        },
      "maximum": {
          "value": "string",
          "currency": "string"
        }
    },
    "otherService": {
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
            "value": "string",
            "currency": "string"
          },
        "maximum": {
            "value": "string",
            "currency": "string"
          }
      }
  },
  "serviceBundles": [
    {
      "name": "string",
      "service": [
        {
          "code": "string",
          "eventLimitQuantity": "string",
          "freeEventQuantity": "string"
        }
      ],
      "prices": [
        {
          "interval": "string",
          "monthlyFee": "string",
          "currency": "string"
        }
      ],
      "minimum": {
        "value": "string",
        "currency": "string"
      },
      "maximum": {
        "value": "string",
        "currency": "string"
      }
    }
  ],
  "openingClosingChannels": "string",
  "additionalInfo":"string",
  "transactionMethods": "string",
  "termsConditions": {
  "minimumBalance": {
        "value": "string",
        "currency": "string"

    },
    "elegibilityCriteriaInfo": "string",
    "closingProcessInfo": "string"
  },
  "incomeRates": [{
    "savingAccount": "string",
    "prePaidPaymentAccount": {
        "applications":{
          "interval":"string",
          "rate":"string"
        },
        "minimumRate": "string",
        "maxiumRate": "string"
    }
  }]
}
Nome Tipo Obrigatório Descrição
type Enum TypePersonalAccount Sim Tipos de contas ofertadas para pessoas físicas, conforme Resolução 3.919 do Banco Central do Brasil.
fees FeesPersonalAccount Sim Lista Tarifas cobradas.
serviceBundle ServiceBundlePersonalAccount Sim Nome dos pacotes de serviços.
openingClosingChannels Enum PersonalAccountOpeningClosingChannels Sim Canais disponíveis para abertura e encerramento de contas.
additionalInfo string Sim Texto livre para complementar informação relativa ao Canal disponível.
transactionMethods Enum PersonalAccountOpeningTransactionMethods Sim Lista de formas de movimentação possíveis para a conta.
termsConditions TermsConditionsPersonalAccount Sim Termos e condições contratuais.
incomeRates IncomeRatesPersonalAccount Sim Valores dos percentuais de taxas.

Enum TypePersonalAccount

Propriedade Valor Definição
type CONTA_DEPOSITO_A_VISTA Conta de depósito à vista.
type CONTA_POUPANCA Conta Poupança.
type CONTA_PAGAMENTO_PRE_PAGA Conta de pagamento pré paga.

Enum PersonalAccountOpeningClosingChannels

Propriedade Valor Definição
openingClosingChannels DEPENDENCIAS_PROPRIAS Dependências próprias.
openingClosingChannels CORRESPONDENTES_BANCARIOS Correspondentes bancários.
openingClosingChannels INTERNET_BANKING Internet banking.
openingClosingChannels MOBILE_BANKING Mobile banking.
openingClosingChannels CENTRAL_TELEFONICA Central telefônica.
openingClosingChannels CHAT Chat.
openingClosingChannels OUTROS Outros (p.ex. website/appps de terceiros).

Enum PersonalAccountOpeningTransactionMethods

Propriedade Valor Definição
transactionMethods MOVIMENTACAO_ELETRONICA Movimentação eletrônica.
transactionMethods MOVIMENTACAO_CHEQUE Movimentação com cheque.
transactionMethods MOVIMENTACAO_CARTAO Movimentação com cartão.
transactionMethods MOVIMENTACAO_PRESENCIAL Movimentação presencial.

FeesPersonalAccount

{
  "priorityService": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "price": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
        "value": "string",
        "currency": "string"
      },
    "maximum": {
        "value": "string",
        "currency": "string"
      }
  },
  "otherService": {
      "name": "string",
      "code": "string",
      "chargingTriggerInfo": "string",
      "prices": [
        {
          "interval": "string",
          "value": "string",
          "currency": "string"
        }
      ],
      "minimum": {
          "value": "string",
          "currency": "string"
        },
      "maximum": {
          "value": "string",
          "currency": "string"
        }
    }
}
Nome Tipo Obrigatório Descrição
priorityService PriorityServicePersonalAccount Sim Lista Tarifas de serviços prioritários da conta
otherService OtherServicePersonalAccount Sim Lista Tarifas de outros serviços da conta

PriorityServicePersonalAccount

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "price": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
      "value": "string",
      "currency": "string"
    },
  "maximum": {
      "value": "string",
      "currency": "string"
    }
}
Nome Tipo Obrigatório Descrição
name string Sim Nome dos Serviços prioritários, segundo Resolução 3.919 do Bacen, para pessoa física
code Enum CodePriorityServicePersonalAccount Sim Sigla de identificação do Serviço Prioritário, segundo Resolução 3.919 do Bacen
chargingTriggerInfo string Sim Fatos geradores de cobrança que incidem sobre os serviços prioritários, segundo Resolução 3.919 do Bacen, para pessoa física.
prices Price Sim Valor da mediana da tarifa, relativa ao serviço ofertado, informado no período
minimum MinimumPrice Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum MaximumPrice Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

Enum CodePriorityServicePersonalAccount

Propriedade Valor Definição
code CADASTRO CADASTRO
code 2_VIA_CARTAO_DEBITO 2ª via-CARTÃODEBITO
code 2_VIA_CARTAO_POUPANCA 2ª via-CARTÃOPOUPANÇA
code EXCLUSAO_CCF EXCLUSÃO CCF
code SUSTACAO_REVOGACAO SUSTAÇÃO/REVOGAÇÃO
code FOLHA_CHEQUE Fornecimento Folha de cheque
code CHEQUE_ADMINISTRATIVO Cheque Administrativo
code CHEQUE_VISADO Cheque Visado
code SAQUE_PESSOAL Saque Pessoal ou Presencial
code SAQUE_TERMINAL Saque Terminal autoatendimento
code SAQUE_CORRESPONDENTE Saque Correspondente no Pais
code DEPOSITO_IDENTIFICADO Depósito identificado
code EXTRATO_MES_P Extrato mensal presencial
code EXTRATO_MES_E Extrato mensal meios eletrônicos
code EXTRATO_MES_C Extrato mensal Correspondente no Pais
code EXTRATO_MOVIMENTO_P Extrato por período presencial
code EXTRATO_MOVIMENTO_E Extrato por período meio eletrônico
code EXTRATO_MOVIMENTO_C Extrato por período Correspondente no Pais
code MICROFILME Fornecimento de cópia de microfilme, microficha ou assemelhado
code DOC_PESSOAL Transferência por DOC presencial ou pessoal
code DOC_ELETRONICO Transferência por DOC meios eletrônicos
code DOC_INTERNET Transferência por TED via Internet
code TED_PESSOAL Transferência por TED pessoal ou presencial
code TED_ELETRONICO Transferência por TED meio eletrônico
code TED_INTERNET Transferência por TED via Internet
code DOC_TED_AGENDADO_P Transferência agendada TED ou DOC presencial ou pessoal
code DOC_TED_AGENDADO_E Transferência agendada TED ou DOC meio eletrônico
code DOC_TED_AGENDADO_I Transferência agendada TED ou DOC via Internet
code TRANSF_RECURSO_P Transferência entre contas própria instituição presencial ou pessoal
code TRANSF_RECURSO_E Transferência entre contas própria instituição por meios eletrônicos ou Internet
code ORDEM_PAGAMENTO Ordem de Pagamento

OtherServicePersonalAccount

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "prices": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
      "value": "string",
      "currency": "string"
    },
  "maximum": {
      "value": "string",
      "currency": "string"
    }
}
Nome Tipo Obrigatório Descrição
name string Sim Nome atribuído a Outros Serviços disponíveis para os tipos de contas.
code string Não Sigla de identificação de Outros Serviços que incidem sobre os tipos de contas.
chargingTriggerInfo string Sim Outros Fatos geradores de cobrança referentes aos Outros Serviços que incidem sobre as contas comercializadas.
prices [Price] Sim Valor da tarifa cobrada referente aos Outros Serviços.
minimum [MinimumPrice] Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum [MaximumPrice] Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

ServiceBundlePersonalAccount

{
"name":"string",
    "service": [
      {
        "code": "string",
        "eventLimitQuantity": "string",
        "freeEventQuantity": "string"
      }
    ],
    "prices":{
      "interval": "string",
      "monthlyFee":"string",
      "currency":"string"

    },
    "minimum": {
            "value": "string",
            "currency": "string"
          },
    "maximum": {
            "value": "string",
            "currency": "string"
          }

  }
Nome Tipo Obrigatório Descrição
name string Sim Nome do conjunto de serviços
services [ServicesPersonalAccount] Sim Lista de serviços
prices ServiceBundlesPersonalAccountPrice Sim Valor mensal da tarifa referente ao Pacote de Serviços
minimum [MinimumPrice] Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum [MaximumPrice] Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

ServicesPersonalAccount

{
  "code": "string",
  "eventLimitQuantity": "string",
  "freeEventQuantity": "string"
}
Nome Tipo Obrigatório Descrição
code string Sim Código que identifica o Serviço que compõe o Pacote de Serviços.
eventLimitQuantity string Sim Quantidade de eventos previstos no Pacote de Serviços.
freeEventQuantity string Sim Quantidade de eventos previstos no Pacote de Serviços com isenção de Tarifa.

PriceServicesPersonalAccount

{
  "interval": "string",
  "monthlyFee": "string",
  "currency": "string"

}
Nome Tipo Obrigatório Descrição
interval string Sim Faixas de valor referentes ao Serviço que compõe o Pacote de Serviços informado:: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes.
monthlyFee string Sim Valor da mediana da tarifa cobrada, relativa ao Serviço Prioritário, para o tipo de faixa informada.
currency string Sim Moeda referente ao valor máximo da tarifa, segundo modelo ISO-4217.

ServiceBundlesPersonalAccountPrice

{
  "interval": "string",
  "monthlyFee": "string",
  "currency": "string"

}
Nome Tipo Obrigatório Descrição
interval string Sim Faixas de valor referentes ao Serviço que compõe o Pacote de Serviços informado:: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes.
monthlyFee string Sim Valor da mediana da tarifa mensal referente ao Pacote de Serviços.
currency string Sim Moeda referente ao valor do Pacote de serviços, segundo modelo ISO-4217.

TermsConditionsPersonalAccount

{
  "openingClosingChannels": "string",
  "additionalInfo":"string",
  "transactionMethods": "string",
  "termsConditions": {
  "minimumBalance": {
        "value": "string",
        "currency": "string"

    },
    "elegibilityCriteriaInfo": "string",
    "closingProcessInfo": "string"
  }
}
Nome Tipo Obrigatório Descrição
openingClosingChannels string Sim Canais disponíveis para abertura e encerramento de contas.
additionalInfo string Sim Texto livre para complementar informação relativa ao Canal disponível, quando no campo 'openingClosingChannels' estiver preenchida a opção 'Outros'
transactionMethods string Sim Lista de formas de movimentação possíveis para a conta.
minimumBalance string Sim Saldo mínimo exigido nos Termos e condições contratuais, que regem as contas comercializadas.
elegibilityCriteriaInfo string Sim Critérios de qualificação do cliente com a finalidade de definir sua elegibilidade para a aquisição do tipo de conta.
closingProcessInfo string Sim Procedimentos de encerramento para o tipo de conta tratado.

IncomeRatesPersonalAccount

 {
  "savingAccount": "string",
  "prePaidPaymentAccount": {
      "applications":[{
        "interval":"string",
        "rate":"string"
      }],
      "minimumRate": "string",
      "maxiumRate": "string"
  }
}
Nome Tipo Obrigatório Descrição
savingAccount string Sim Descrição da Remuneração especificamente para Conta de Poupança. Deve ser preenchido com a determinação legal vigente.
prePaidPaymentAccount string Sim Remuneração efetivamente aplicada para CONTA_PAGAMENTO_PRE_PAGA

ResponsePersonalLoansList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "personalLoans": [
            {
              "type": "string",
              "fees": [
                {
                  "service":{
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "interestRate": [
                {
                  "applications": [
                    {
                      "interval": "string",
                      "rate": "string",
                    }
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                }
              ],
              "requiredWarranties": [
                "string"
              ],
              "termsConditions": "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 PersonalLoanBrand Sim Organização titular das dependências
links LinksPaginated Sim
meta MetaPaginated Sim

PersonalLoanBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "personalLoans": [
        {
          "type": "string",
          "fees": [
            {
              "service":{
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                  "value": "string",
                  "currency": "string"
                },
                "maximum": {
                  "value": "string",
                  "currency": "string"
                }
              }
            }
          ],
          "interestRate": [
            {
              "applications": [
                {
                  "interval": "string",
                  "rate": "string",
                }
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            }
          ],
          "requiredWarranties": [
            "string"
          ],
          "termsConditions": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da marca proprietária da dependência (titular).
companies PersonalLoanCompany Sim Lista de instituições pertencentes à marca

PersonalLoanCompany

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "personalLoans": [
    {
      "type": "string",
      "fees": [
        {
          "service":{
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "interestRate": [
        {
          "applications": [
            {
              "interval": "string",
              "rate": "string",
            }
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        }
      ],
      "requiredWarranties": [
        "string"
      ],
      "termsConditions": "string"
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização das modalidades de Empréstimos para Pessoas Físicas consultadas.
cnpjNumber string Sim O responsável pela comercialização das modalidades de Empréstimos para Pessoas Físicas consultadas - 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 URIString Sim 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.
personalLoans PersonalLoan Sim Empréstimos Pessoas Físicas

PersonalLoan

 {
  "type": "string",
  "fees": [
    {
      "service":{
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "interestRate": [
    {
      "applications": [
        {
          "interval": "string",
          "rate": "string",
        }
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    }
  ],
  "requiredWarranties": [
    "string"
  ],
  "termsConditions": "string"
}
Nome Tipo Obrigatório Definição
type Enum PersonalLoanType Sim Modalidades de empréstimos ofertados para pessoas Físicas, conforme Circular 4015-Bacem
fees LoanFee Sim Tarifas cobradas sobre Serviços ofertados à Modalidade de Empréstimo
interestRate LoanInterestRate Sim Taxas de juros remuneratórias
requiredWarranties Enum RequiredWarranty Sim Relação de garantias exigidas, segundo documento 3040 do Bacem
termsConditions string Não Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL (URIString) referente ao endereço onde constam as condições informadas.

Enum PersonalLoanType

Propriedade Código Definição
type ADIANTAMENTO_DEPOSITANTE Adiantamento a depositante
type EMPRESTIMO_CREDITO_PESSOAL_CONSIGNADO Crédito pessoal consignado
type EMPRESTIMO_CREDITO_PESSOAL_NAO_CONSIGNADO Crédito pessoal não consignado
type EMPRESTIMO_HOME_EQUITY Home equity
type EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO Microcrédito produtivo orientado
type EMPRESTIMO_CHEQUE_ESPECIAL Cheque especial
type EMPRESTIMO_CONTA_GARANTIDA Conta garantida

Enum RequiredWarranty

Propriedade Código Definição
requiredWarranty CESSAO_DIREITOS_CREDITORIOS Cessão de direitos creditórios
requiredWarranty CAUCAO Caução
requiredWarranty PENHOR Penhor
requiredWarranty ALIENACAO_FIDUCIARIA Alienação fiduciária
requiredWarranty HIPOTECA Hipoteca
requiredWarranty OPERACOES_GARANTIDAS_PELO_GOVERNO Operações garantidas pelo governo
requiredWarranty OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS Outras garantias não fidejussórias
requiredWarranty SEGUROS_ASSEMELHADOS Seguros e assemelhados
requiredWarranty GARANTIA_FIDEJUSSORIA Garantia fidejussória
requiredWarranty BENS_ARRENDADOS Bens arrendados
requiredWarranty GARANTIAS_INTERNACIONAIS Garantias internacionais
requiredWarranty OPERACOES_GARANTIDAS_OUTRAS_ENTIDADES
Operações garantidas por outras entidades
requiredWarranty ACORDOS_COMPENSACAO Acordos de compensação
requiredWarranty NAO_APLICAVEL Não aplicável

LoanFee

{
  "service":{
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
      "value": "string",
      "currency": "string"
    },
    "maximum": {
      "value": "string",
      "currency": "string"
    }
  }
}
Nome Tipo Obrigatório Definição Restrições
name string Sim Nomes das Tarifas cobradas sobre Serviços relacionados à Modalidade informada do Empréstimo para pessoa física/jurídica. NA
code string Sim Sigla de identificação do serviço relacionado à Modalidade informada de Empréstimo para pessoa física/jurídica. NA
chargingTriggerInfo string Sim Fatos geradores de cobrança que incidem sobre as Modalidades informada de Empréstimos para pessoa física/jurídica. NA
prices Price Sim Valor da mediana da tarifa, relativa ao serviço ofertado, informado no período. NA
minimum MinimumPrice Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência. NA
maximum MaximumPrice Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência. NA

LoanInterestRate

{
  "applications": [
    {
      "interval": "string",
      "rate": "string",
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
applications Application Sim Valor da mediana da taxa de remuneração relativa ao serviço ofertado.
minimumRate string Sim Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)
maximumRate string Sim Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)

ResponseBusinessLoansList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "businessLoans": [
            {
              "type": "string",
              "fees": [
                {
                  "service":{
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "interestRate": [
                {
                  "applications": [
                    {
                      "interval": "string",
                      "rate": "string",
                    }
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                }
              ],
              "requiredWarranties": [
                "string"
              ],
              "termsConditions": "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 BusinessLoanBrand Sim organização titular das dependências
links LinksPaginated Sim
meta MetaPaginated Sim

BusinessLoanBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "businessLoans": [
        {
          "type": "string",
          "fees": [
            {
              "service":{
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                  "value": "string",
                  "currency": "string"
                },
                "maximum": {
                  "value": "string",
                  "currency": "string"
                }
              }
            }
          ],
          "interestRate": [
            {
              "applications": [
                {
                  "interval": "string",
                  "rate": "string",
                }
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            }
          ],
          "requiredWarranties": [
            "string"
          ],
          "termsConditions": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da marca proprietária da dependência (titular).
companies BusinessLoanCompany Sim Lista de instituições pertencentes à marca

BusinessLoanCompany

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "businessLoans": [
    {
      "type": "string",
      "fees": [
        {
          "service":{
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "interestRate": [
        {
          "applications": [
            {
              "interval": "string",
              "rate": "string",
            }
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        }
      ],
      "requiredWarranties": [
        "string"
      ],
      "termsConditions": "string"
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização das modalidades de Empréstimos para Pessoas Jurídicas consultadas.
cnpjNumber string Sim O responsável pela comercialização das modalidades de Empréstimos para Pessoas Jurídicas consultadas - 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 URIString Sim 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.
businessLoans BusinessLoan Sim Empréstimos Pessoas Jurídicas

BusinessLoan

{
  "type": "string",
  "fees": [
    {
      "service":{
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "interestRate": [
    {
      "applications": [
        {
          "interval": "string",
          "rate": "string",
        }
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    }
  ],
  "requiredWarranties": [
    "string"
  ],
  "termsConditions": "string"
}
Nome Tipo Obrigatório Definição
type Enum BusinessLoanType Sim Modalidades de empréstimos ofertados para pessoas jurídicas, conforme Circular 4015-Bacem
fees LoanFee Sim Tarifas cobradas sobre Serviços ofertados à Modalidade de Empréstimo
interestRate LoanInterestRate Sim Taxas de juros remuneratórias
requiredWarranties Enum RequiredWarranty Sim Relação de garantias exigidas, segundo documento 3040 do Bacem
termsConditions string Não Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL ([URIString]) referente ao endereço onde constam as condições informadas.

Enum BusinessLoanType

Propriedade Código Definição
type ADIANTAMENTO_DEPOSITANTE Adiantamento a depositante
type EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO Microcrédito produtivo orientado
type EMPRESTIMO_CHEQUE_ESPECIAL Cheque especial
type EMPRESTIMO_CONTA_GARANTIDA Conta garantida
type EMPRESTIMO_CAPITAL_GIRO_PRAZO_VENCIMENTO_ATE_365_DIAS Capital de giro com prazo de vencimento até 365 dias
type EMPRESTIMO_CAPITAL_GIRO_PRAZO_VENCIMENTO_SUPERIOR_365_DIAS Capital de giro com prazo de vencimento superior a 365 dias
type EMPRESTIMO_CAPITAL_GIRO_ROTATIVO Capital de giro rotativo

ResponsePersonalFinancingsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "cnpjNumber": "string",
          "name": "string",
          "urlComplementaryList": "string",
          "personalFinancings": [
            {
              "type": "string",
              "fees": [
                {
                  "service": {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ],
                "minimumRate": "string",
                "maximumRate": "string"
              },
              "requiredWarranties": [
                "string"
              ],
              "termsConditions": "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 PersonalFinancingBrand Sim Organização titular das dependências
links LinksPaginated Sim
meta MetaPaginated Sim

PersonalFinancingBrand

{
  "brand": {
    "name": "string",
    "companies": [
      {
        "cnpjNumber": "string",
        "name": "string",
        "urlComplementaryList": "string",
        "personalFinancings": [
          {
            "type": "string",
            "fees": [
              {
                "service": {
                  "name": "string",
                  "code": "string",
                  "chargingTriggerInfo": "string",
                  "prices": [
                    {
                      "interval": "string",
                      "value": "string",
                      "currency": "string"
                    }
                  ],
                  "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                  "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
                }
              }
            ],
            "interestRate": {
              "applications": [
                {
                  "interval": "string",
                  "rate": "string"
                }
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            },
            "requiredWarranties": [
              "string"
            ],
            "termsConditions": "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 PersonalFinancingCompany Sim Lista de instituições pertencentes à marca.

PersonalFinancingCompany

{
  "cnpjNumber": "string",
  "name": "string",
  "urlComplementaryList": "string",
  "personalFinancings": [
    {
      "type": "string",
      "fees": [
        {
          "service": {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "interestRate": {
        "applications": [
          {
            "interval": "string",
            "rate": "string"
          }
        ],
        "minimumRate": "string",
        "maximumRate": "string"
      },
      "requiredWarranties": [
        "string"
      ],
      "termsConditions": "string"
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização das modalidades de Financiamentos para Pessoas Físicas consultadas. p.ex.'Empresa da Organização A'.
cnpjNumber string Sim CNPJ da instituição responsável.
urlComplementaryList URIString Sim 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.
personalFinancings PersonalFinancing Sim Lista de financiamentos.

PersonalFinancing

{
  "type": "string",
  "fees": [
    {
      "service": {
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "interestRate": {
    "applications": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "requiredWarranties": [
    "string"
  ],
  "termsConditions": "string"
}
Nome Tipo Obrigatório Definição
type Enum PersonalFinancingType Sim Modalidades de financiamentos ofertados para pessoas físicas, conforme Circular 4015-Banco Central do Brasil. Segundo cartilha do Banco Central do Brasil: Financiamento é um contrato entre o cliente e uma instituição financeira, mas com, destinação específica como para a aquisição de veículo ou de bem imóvel, que funcionam como garantia para o crédito concedido.
fees PersonalFinancingFee Sim Valor da mediana da tarifa, relativa ao serviço ofertado, para pessoa física, informado no período. p.ex. '45.00'00'
interestRate PersonalFinancingInterestRate Sim Lista de taxas de juros.
requiredWarranties Enum PersonalFinancingRequiredWarranty Sim Relação de garantias exigidas.
termsConditions string Não Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL (URIString) referente ao endereço onde constam as condições informadas.

Enum PersonalFinancingType

Propriedade Código Definição
type FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES Aquisição de bens – veículos automotores.
type FINANCIAMENTO_AQUISICAO_BENS_OUTROS_BENS Aquisição de bens – outros bens.
type FINANCIAMENTO_MICROCREDITO operação de crédito realizada para financiamento de atividades produtivas de pessoas naturais ou jurídicas, organizadas de forma individual ou coletiva, com renda ou receita bruta anual de até R$200.000,00 (duzentos mil reais)
type FINANCIAMENTO_RURAL_CUSTEIO Financiamentos rurais - custeio.
type FINANCIAMENTO_RURAL_INVESTIMENTO Financiamentos rurais - investimento.
type FINANCIAMENTO_RURAL_COMERCIALIZACAO Financiamentos rurais - comercialização.
type FINANCIAMENTO_RURAL_INDUSTRIALIZACAO Financiamentos rurais - industrialização.
type FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCIERO_HABILITACAO_SFH Financimento imobiliário - Sistema Financeiro da Habitação (SFH).
type FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCIERO_HABILITACAO_SFI Financimento imobiliário - Sistema Financeiro da Imobiliário (SFI).

Enum PersonalFinancingRequiredWarranty

Propriedade Código Definição
requiredWarranty CESSAO_DIREITOS_CREDITORIOS Cessão de direitos creditórios.
requiredWarranty CAUCAO Caução.
requiredWarranty PENHOR Penhor.
requiredWarranty ALIENACAO_FIDUCIARIA Alienação fiduciária.
requiredWarranty HIPOTECA Hipoteca.
requiredWarranty OPERCAOES_GARANTIDAS_PELO_GOVERNO Operações garantidas pelo governo.
requiredWarranty OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS Outras garantias não fidejussórias.
requiredWarranty SEGUROS_ASSEMELHADOS Seguros e assemelhados.
requiredWarranty GARANTIA_FIDEJUSSORIA Garantia fidejussória.
requiredWarranty BENS_ARRENDADOS Bens arrendados.
requiredWarranty GARANTIAS_INTERNACIONAIS Garantias internacionais.
requiredWarranty OPERACOES_GARANTIDAS_OUTRAS_ENTIDADES Operações garantidas por outras entidades.
requiredWarranty ACORDOS_COMPENSACAO Acordos de compensação.
requiredWarranty NAO_APLICAVEL Não aplicável.

PersonalFinancingFee

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
      "value": "string",
      "currency": "string"
    },
    "maximum": {
      "value": "string",
      "currency": "string"
    }
  }
}
Nome Tipo Obrigatório Definição
name string Sim Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de Financiamento, para pessoa física.
code string Sim Sigla de identificação do serviço relacionado à Modalidade de Financiamento informada, para pessoa física. Campo Aberto.
chargingTriggerInfo string Não Fatos geradores de cobrança que incidem sobre as Modalidades de Financiamentos, para pessoa física. Campo Aberto.
prices [Price] Sim Valor da mediana da tarifa, relativa ao serviço ofertado, para pessoa física, informado no período. p.ex. '45.00'
minimum [MinimumPrice] Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum [MaximumPrice] Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

PersonalFinancingInterestRate

{
  "applications": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
applications [Application] Sim Valor da mediana da taxa de remuneração relativa ao serviço ofertado, para pessoa física informado no período.
minimumRate string Sim Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)
maximumRate string Sim Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)

ResponseBusinessFinancingsList

{
  "data":  {
    "brand": {
      "name": "string",
      "companies": [
        {
          "cnpjNumber": "string",
          "name": "string",
          "urlComplementaryList": "string",
          "businessFinancings": [
            {
              "type": "string",
              "fees": [
                {
                  "service": {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "interestRate": {
                "applications": [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ],
                "minimumRate": "string",
                "maximumRate": "string"
              },
              "requiredWarranties": [
                "string"
              ],
              "termsConditions": "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 BusinessFinancingBrand Sim Organização titular das dependências
links LinksPaginated Sim
meta MetaPaginated Sim

BusinessFinancingBrand

{
  "name": "string",
  "companies": [
    {
      "cnpjNumber": "string",
      "name": "string",
      "urlComplementaryList": "string",
      "businessFinancings": [
        {
          "type": "string",
          "fees": [
            {
              "service": {
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                  "value": "string",
                  "currency": "string"
                },
                "maximum": {
                  "value": "string",
                  "currency": "string"
                }
              }
            }
          ],
          "interestRate": {
            "applications": [
              {
                "interval": "string",
                "rate": "string"
              }
            ],
            "minimumRate": "string",
            "maximumRate": "string"
          },
          "requiredWarranties": [
            "string"
          ],
          "termsConditions": "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 BusinessFinancingCompany Sim Lista de instituições pertencentes à marca.

BusinessFinancingCompany

{
  "cnpjNumber": "string",
  "name": "string",
  "urlComplementaryList": "string",
  "businessFinancings": [
    {
      "type": "string",
      "fees": [
        {
          "service": {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "interestRate": {
        "applications": [
          {
            "interval": "string",
            "rate": "string"
          }
        ],
        "minimumRate": "string",
        "maximumRate": "string"
      },
      "requiredWarranties": [
        "string"
      ],
      "termsConditions": "string"
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização das modalidades de Financiamentos para Pessoas Físicas consultadas. p.ex.'Empresa da Organização A'.
cnpjNumber string Sim CNPJ da instituição responsável.
urlComplementaryList URIString Sim 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.
businessFinancings BusinessFinancing Sim Lista de financiamentos.

BusinessFinancing

{
  "type": "string",
  "fees": [
    {
      "service": {
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "interestRate": {
    "applications": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "requiredWarranties": [
    "string"
  ],
  "termsConditions": "string"
}
Nome Tipo Obrigatório Definição
type Enum BusinessFinancingType Sim Modalidades de financiamentos ofertados para pessoas jurídicas, conforme Circular 4015-Banco Central do Brasil. Segundo cartilha do Banco Central do Brasil: Financiamento é um contrato entre o cliente e uma instituição financeira, mas com, destinação específica como para a aquisição de veículo ou de bem imóvel, que funcionam como garantia para o crédito concedido.
fees BusinessFinancingFee Sim Lista das Tarifas cobradas sobre Serviços ofertados à Modalidade de Financiamento, para pessoa jurídica.
interestRate BusinessFinancingInterestRate Sim Lista de taxas de juros.
requiredWarranties Enum BusinessFinancingRequiredWarranty Sim Relação de garantias exigidas.
termsConditions string Não Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL (URIString) referente ao endereço onde constam as condições informadas.

Enum BusinessFinancingType

Propriedade Código Definição
type FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES Aquisição de bens – veículos automotores.
type FINANCIAMENTO_AQUISICAO_BENS_OUTROS_BENS Aquisição de bens – outros bens.
type FINANCIAMENTO_MICROCREDITO operação de crédito realizada para financiamento de atividades produtivas de pessoas naturais ou jurídicas, organizadas de forma individual ou coletiva, com renda ou receita bruta anual de até R$200.000,00 (duzentos mil reais)
type FINANCIAMENTO_RURAL_CUSTEIO Financiamentos rurais - custeio.
type FINANCIAMENTO_RURAL_INVESTIMENTO Financiamentos rurais - investimento.
type FINANCIAMENTO_RURAL_COMERCIALIZACAO Financiamentos rurais - comercialização.
type FINANCIAMENTO_RURAL_INDUSTRIALIZACAO Financiamentos rurais - industrialização.
type FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCIERO_HABILITACAO_SFH Financimento imobiliário - Sistema Financeiro da Habitação (SFH.
type FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCIERO_HABILITACAO_SFI Financimento imobiliário - Sistema Financeiro da Imobiliário (SFI).

Enum BusinessFinancingRequiredWarranty

Propriedade Código Definição
requiredWarranty CESSAO_DIREITOS_CREDITORIOS Cessão de direitos creditórios.
requiredWarranty CAUCAO Caução.
requiredWarranty PENHOR Penhor.
requiredWarranty ALIENACAO_FIDUCIARIA Alienação fiduciária.
requiredWarranty HIPOTECA Hipoteca.
requiredWarranty OPERACOES_GARANTIDAS_GOVERNO Operações garantidas pelo governo.
requiredWarranty OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS Outras garantias não fidejussórias.
requiredWarranty SEGUROS_ASSEMELHADOS Seguros e assemelhados.
requiredWarranty GARANTIA_FIDEJUSSORIA Garantia fidejussória.
requiredWarranty BENS_ARRENDADOS Bens arrendados.
requiredWarranty GARANTIAS_INTERNACIONAIS Garantias internacionais.
requiredWarranty OPERACOES_GARANTIDAS_OUTRAS_ENTIDADE Operações garantidas por outras entidades.
requiredWarranty ACORDOS_COMPENSACAO Acordos de compensação.
requiredWarranty NAO_APLICAVEL Não aplicável.

BusinessFinancingFee

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
      "value": "string",
      "currency": "string"
    },
    "maximum": {
      "value": "string",
      "currency": "string"
    }
  }
}
Nome Tipo Obrigatório Definição
name string Sim Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de Financiamento, para pessoa jurídica.
code string Sim Sigla de identificação do serviço relacionado à Modalidade de Financiamento informada, para pessoa jurídica. Campo aberto.
chargingTriggerInfo string Não Fatos geradores de cobrança que incidem sobre as Modalidades de Financiamentos, para pessoa jurídica. Campo Aberto.
prices Price Sim Valor da mediana da tarifa, relativa ao serviço ofertado, informado no período.
minimum MinimumPrice Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum MaximumPrice Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

BusinessFinancingInterestRate

{
  "applications": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
applications Application Sim Valor da mediana da taxa de remuneração relativa ao serviço ofertado, para pessoa física informado no período.
minimumRate string Sim Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)
maximumRate string Sim Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)

ResponsePersonalInvoiceFinancingsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "personalInvoiceFinancings": [
            {
              "type": "string",
              "fees": [{
                "service": {
                  "name": "string",
                  "code": "string",
                  "chargingTriggerInfo": "string",
                  "prices": [
                    {
                      "interval": "string",
                      "value": "string",
                      "currency": "string"
                    }
                  ],
                  "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                  "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
                }
              }],
              "interestRate": {
                "applications": [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ],
                "minimumRate": "string",
                "maximumRate": "string"
              },
              "requiredWarranties": [
                "string"
              ],
              "termsConditions": "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 [PersonalInvoiceFinancingsBrand] Sim Lista das organizaçõs titulares das dependências
links [LinksPaginated] Sim
meta MetaPaginated Sim

PersonalInvoiceFinancingsBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "personalInvoiceFinancings": [
        {
          "type": "string",
          "fees": [{
            "service": {
              "name": "string",
              "code": "string",
              "chargingTriggerInfo": "string",
              "prices": [
                {
                  "interval": "string",
                  "value": "string",
                  "currency": "string"
                }
              ],
              "minimum": {
                "value": "string",
                "currency": "string"
              },
              "maximum": {
                "value": "string",
                "currency": "string"
              }
            }
          }],
          "interestRate": {
            "applications": [
              {
                "interval": "string",
                "rate": "string"
              }
            ],
            "minimumRate": "string",
            "maximumRate": "string"
          },
          "requiredWarranties": [
            "string"
          ],
          "termsConditions": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da marca proprietária da dependência (titular).
companies [PersonalInvoiceFinancingsCompanies] Sim Lista de instituições pertencentes à marca

PersonalInvoiceFinancingsCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "personalInvoiceFinancings": [
    {
      "type": "string",
      "fees": [{
        "service": {
          "name": "string",
          "code": "string",
          "chargingTriggerInfo": "string",
          "prices": [
            {
              "interval": "string",
              "value": "string",
              "currency": "string"
            }
          ],
          "minimum": {
            "value": "string",
            "currency": "string"
          },
          "maximum": {
            "value": "string",
            "currency": "string"
          }
        }
      }],
      "interestRate": {
        "applications": [
          {
            "interval": "string",
            "rate": "string"
          }
        ],
        "minimumRate": "string",
        "maximumRate": "string"
      },
      "requiredWarranties": [
        "string"
      ],
      "termsConditions": "string"
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização das modalidades de Financiamentos para Pessoas Físicas consultadas. p.ex.'Empresa da Organização A'.
cnpjNumber string Sim CNPJ da instituição responsável
urlComplementaryList [URIString] Sim 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.
personalInvoiceFinancings [PersonalInvoiceFinancings] Sim Lista de antecipação de recebíveis

PersonalInvoiceFinancings

{
  "type": "string",
  "fees": [{
    "service": {
      "name": "string",
      "code": "string",
      "chargingTriggerInfo": "string",
      "prices": [
        {
          "interval": "string",
          "value": "string",
          "currency": "string"
        }
      ],
      "minimum": {
        "value": "string",
        "currency": "string"
      },
      "maximum": {
        "value": "string",
        "currency": "string"
      }
    }
  }],
  "interestRate": {
    "applications": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "requiredWarranties": [
    "string"
  ],
  "termsConditions": "string"
}
Nome Tipo Obrigatório Definição
type Enum PersonalInvoiceFinancingsType Sim Modalidades de direitos creditórios descontados ofertados para pessoas Físicas, conforme Circular 4015-Bacen. Direito creditório descontado é a antecipação de créditos relativos p.ex.: desconto de duplicatas, desconto de cheques, antecipação de fatura de cartão de crédito
fees [PersonalInvoiceFinancingsFees] Sim Lista das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa física
interestRate [PersonalInvoiceFinancingsInterestRates] Sim Lista de taxas de juros remuneratórias
requiredWarranties [Enum PersonalInvoiceFinancingsRequiredWarranties] Sim Relação de garantias exigidas
termsConditions string Não Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL ([URIString]) referente ao endereço onde constam as condições informadas.

Enum PersonalInvoiceFinancingsType

Propriedade Código Definição
type DESCONTO_DUPLICATAS Desconto de duplicatas
type DESCONTO_CHEQUES Desconto de cheques
type ANTECIPACAO_FATURA_CARTAO_CREDITO Antecipação de fatura de cartão de crédito
type OUTROS_DIREITOS_CREDITORIOS_DESCONTADOS Outros direitos creditórios descontados
type OUTROS_TITULOS_DESCONTADOS Outros títulos descontados

Enum PersonalInvoiceFinancingsRequiredWarranties

Propriedade Código Definição
requiredWarranties CESSAO_DIREITOS_CREDITORIOS Cessão de direitos creditórios
requiredWarranties CAUCAO Caução
requiredWarranties PENHOR Penhor
requiredWarranties ALIENACAO_FIDUCIARIA Alienação fiduciária
requiredWarranties HIPOTECA Hipoteca
requiredWarranties OPERACOES_GARANTIDAS_GOVERNO Operações garantidas pelo governo
requiredWarranties OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS Outras garantias não fidejussórias
requiredWarranties SEGUROS_ASSEMELHADOS Seguros e assemelhados
requiredWarranties GARANTIA_FIDEJUSSORIA Garantia fidejussória
requiredWarranties BENS_ARRENDADOS Bens arrendados
requiredWarranties GARANTIAS_INTERNACIONAIS Garantias internacionais
requiredWarranties OPERACOES_GARANTIDAS_OUTRAS_ENTIDADE Operações garantidas por outras entidades
requiredWarranties ACORDOS_COMPENSACAO Acordos de compensação
requiredWarranties NAO_APLICAVEL Não aplicável

PersonalInvoiceFinancingsFees

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
      "value": "string",
      "currency": "string"
    },
    "maximum": {
      "value": "string",
      "currency": "string"
    }
  }
}
Nome Tipo Obrigatório Definição
service [PersonalInvoiceFinancingsFeesService] Sim Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa física. (Campo Livre)

PersonalInvoiceFinancingsFeesService

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "prices": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
    "value": "string",
    "currency": "string"
  },
  "maximum": {
    "value": "string",
    "currency": "string"
  }
}
Nome Tipo Obrigatório Definição
name string Sim Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa física. (Campo Livre)
code string Sim Sigla de identificação do serviço relacionado à Modalidade de direitos creditórios descontados, para pessoa física. Campo aberto
chargingTriggerInfo string Não Fatos geradores de cobrança que incidem sobre as Modalidades de direitos creditórios descontados, para pessoa física. Campo Livre
prices [Price] Sim Valor da mediana, relativa ao serviço ofertado, informado no período.
minimum [MinimumPrice] Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum [MaximumPrice] Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

PersonalInvoiceFinancingsInterestRates

{
  "applications": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
applications [Price] Sim Valor da mediana da taxa de remuneração relativa ao serviço ofertado, para pessoa física informado no período.
minimumRate string Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado, sobre a base de clientes, no mês de referência
maximumRate string Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado, sobre a base de clientes, no mês de referência

ResponseBusinessInvoiceFinancingsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "businessInvoiceFinancings": [
            {
              "type": "string",
              "fees": [{
                "service": {
                  "name": "string",
                  "code": "string",
                  "chargingTriggerInfo": "string",
                  "prices": [
                    {
                      "interval": "string",
                      "value": "string",
                      "currency": "string"
                    }
                  ],
                  "minimum": {
                    "value": "string",
                    "currency": "string"
                  },
                  "maximum": {
                    "value": "string",
                    "currency": "string"
                  }
                }
              }],
              "interestRate": {
                "applications": [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ],
                "minimumRate": "string",
                "maximumRate": "string"
              },
              "requiredWarranties": [
                "string"
              ],
              "termsConditions": "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 [BusinessInvoiceFinancingsBrand] Sim Lista das organizaçõs titulares das dependências
links [LinksPaginated] Sim
meta MetaPaginated Sim

BusinessInvoiceFinancingsBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "businessInvoiceFinancings": [
        {
          "type": "string",
          "fees": [{
            "service": {
              "name": "string",
              "code": "string",
              "chargingTriggerInfo": "string",
              "prices": [
                {
                  "interval": "string",
                  "value": "string",
                  "currency": "string"
                }
              ],
              "minimum": {
                "value": "string",
                "currency": "string"
              },
              "maximum": {
                "value": "string",
                "currency": "string"
              }
            }
          }],
          "interestRate": {
            "applications": [
              {
                "interval": "string",
                "rate": "string"
              }
            ],
            "minimumRate": "string",
            "maximumRate": "string"
          },
          "requiredWarranties": [
            "string"
          ],
          "termsConditions": "string"
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da marca proprietária da dependência (titular).
companies [BusinessInvoiceFinancingsCompanies] Sim Lista de instituições pertencentes à marca

BusinessInvoiceFinancingsCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "businessInvoiceFinancings": [
    {
      "type": "string",
      "fees": [{
        "service": {
          "name": "string",
          "code": "string",
          "chargingTriggerInfo": "string",
          "prices": [
            {
              "interval": "string",
              "value": "string",
              "currency": "string"
            }
          ],
          "minimum": {
            "value": "string",
            "currency": "string"
          },
          "maximum": {
            "value": "string",
            "currency": "string"
          }
        }
      }],
      "interestRate": {
        "applications": [
          {
            "interval": "string",
            "rate": "string"
          }
        ],
        "minimumRate": "string",
        "maximumRate": "string"
      },
      "requiredWarranties": [
        "string"
      ],
      "termsConditions": "string"
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Instituição, pertencente à marca, responsável pela comercialização das modalidades de Direitos Creditórios Descontados para Pessoas Físicas consultadas. p.ex.'Empresa da Organização A'.
cnpjNumber string Sim CNPJ da instituição responsável
urlComplementaryList [URIString] Sim 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.
businessInvoiceFinancings [BusinessInvoiceFinancings] Sim Lista de antecipação de recebíveis

BusinessInvoiceFinancings

{
  "type": "string",
  "fees": {
    "service": {
      "name": "string",
      "code": "string",
      "chargingTriggerInfo": "string",
      "prices": [
        {
          "interval": "string",
          "value": "string",
          "currency": "string"
        }
      ],
      "minimum": {
        "value": "string",
        "currency": "string"
      },
      "maximum": {
        "value": "string",
        "currency": "string"
      }
    }
  },
  "interestRate": {
    "applications": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "requiredWarranties": [
    "string"
  ],
  "termsConditions": "string"
}
Nome Tipo Obrigatório Definição
type Enum BusinessInvoiceFinancingsType Sim Modalidades de direitos creditórios descontados ofertados para pessoas Jurídicas, conforme Circular 4015-Bacen. Direito creditório descontado é a antecipação de créditos relativos p.ex.: desconto de duplicatas, desconto de cheques,antecipação de fatura de cartão de crédito
fees [BusinessInvoiceFinancingsFees] Sim Lista das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa jurídica
interestRate [BusinessInvoiceFinancingsInterestRates] Sim Lista de taxas de juros remuneratórias
requiredWarranties [Enum BusinessInvoiceFinancingsRequiredWarranties] Sim Relação de garantias exigidas
termsConditions string Não Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL ([URIString]) referente ao endereço onde constam as condições informadas.

Enum BusinessInvoiceFinancingsType

Propriedade Código Definição
type DESCONTO_DUPLICATAS Desconto de duplicatas
type DESCONTO_CHEQUES Desconto de cheques
type ANTECIPACAO_FATURA_CARTAO_CREDITO Antecipação de fatura de cartão de crédito
type OUTROS_DIREITOS_CREDITORIOS_DESCONTADOS Outros direitos creditórios descontados
type OUTROS_TÍTULOS_DESCONTADOS Outros títulos descontados

Enum BusinessInvoiceFinancingsRequiredWarranties

Propriedade Código Definição
requiredWarranties CESSAO_DIREITOS_CREDITORIOS Cessão de direitos creditórios
requiredWarranties CAUCAO Caução
requiredWarranties PENHOR Penhor
requiredWarranties ALIENACAO_FIDUCIARIA Alienação fiduciária
requiredWarranties HIPOTECA Hipoteca
requiredWarranties OPERACOES_GARANTIDAS_GOVERNO Operações garantidas pelo governo
requiredWarranties OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS Outras garantias não fidejussórias
requiredWarranties SEGUROS_ASSEMELHADOS Seguros e assemelhados
requiredWarranties GARANTIA_FIDEJUSSORIA Garantia fidejussória
requiredWarranties BENS_ARRENDADOS Bens arrendados
requiredWarranties GARANTIAS_INTERNACIONAIS Garantias internacionais
requiredWarranties OPERACOES_GARANTIDAS_OUTRAS_ENTIDADE Operações garantidas por outras entidades
requiredWarranties ACORDOS_COMPENSACAO Acordos de compensação
requiredWarranties NAO_APLICAVEL Não aplicável

BusinessInvoiceFinancingsFees

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
      {
        "interval": "string",
        "value": "string",
        "currency": "string"
      }
    ],
    "minimum": {
      "value": "string",
      "currency": "string"
    },
    "maximum": {
      "value": "string",
      "currency": "string"
    }
  }
}
Nome Tipo Obrigatório Definição
service [BusinessInvoiceFinancingsFeesService] Sim Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa física. (Campo Livre)

BusinessInvoiceFinancingsFeesService

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "prices": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
    "value": "string",
    "currency": "string"
  },
  "maximum": {
    "value": "string",
    "currency": "string"
  }
}
Nome Tipo Obrigatório Definição
name string Sim Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa física. (Campo Livre)
code string Sim Sigla de identificação do serviço relacionado à Modalidade de direitos creditórios descontados, para pessoa física. Campo aberto
chargingTriggerInfo string Não Fatos geradores de cobrança que incidem sobre as Modalidades de direitos creditórios descontados, para pessoa física. Campo Livre
prices [Price] Sim Valor da mediana, relativa ao serviço ofertado, informado no período.
minimum [MinimumPrice] Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.
maximum [MaximumPrice] Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência.

BusinessInvoiceFinancingsInterestRate

{
  "applications": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
applications [Price] Sim Valor da mediana da taxa de remuneração relativa ao serviço ofertado, para pessoa física informado no período.
minimumRate string Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado, sobre a base de clientes, no mês de referência
maximumRate string Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado, sobre a base de clientes, no mês de referência

ResponsePersonalCreditCardsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "personalCreditCards": [
            {
              "name": "string",
              "identification": {
                "product": {
                  "type": "string",
                  "additionalInfo": "string"
                },
                "creditCard": {
                  "network": "string",
                  "additionalInfo": "string"
                }
              },
              "rewardsProgram": {
                "hasRewardProgram": "string",
                "rewardProgramInfo": "string"
              },
              "fees": [
                {
                  "service": {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "interest": {
                "feeRate": {
                  "prices": [
                    [
                      {
                        "interval": "string",
                        "rate": "string"
                      }
                    ]
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                },
                "instalmentRate": {
                  "prices": [
                    [
                      {
                        "interval": "string",
                        "rate": "string"
                      }
                    ]
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                },
                "interestRates": [{
                  "code": "string",
                  "additionalInfo": "string",
                  "prices": [
                    [
                      {
                        "interval": "string",
                        "rate": "string"
                      }
                    ]
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                }]
              },
              "termsConditions": {
                "minimumFeeRate": "string",
                "additionalInfo": "string",
                "elegibilityCriteriaInfo": "string",
                "closingProcessInfo": "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 PersonalCreditCardBrand Sim Dados da Marca selecionada que fornecem produtos e serviços de cartões de crédito para pessoa jurídica
links LinksPaginated Sim
meta MetaPaginated Sim

PersonalCreditCardBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "personalCreditCards": [
        {
          "name": "string",
          "identification": {
            "product": {
              "type": "string",
              "additionalInfo": "string"
            },
            "creditCard": {
              "network": "string",
              "additionalInfo": "string"
            }
          },
          "rewardsProgram": {
            "hasRewardProgram": "string",
            "rewardProgramInfo": "string"
          },
          "fees": [
            {
              "service": {
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                  "value": "string",
                  "currency": "string"
                },
                "maximum": {
                  "value": "string",
                  "currency": "string"
                }
              }
            }
          ],
          "interest": {
            "feeRate": {
              "prices": [
                [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ]
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            },
            "instalmentRate": {
              "prices": [
                [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ]
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            },
            "interestRates": [{
              "code": "string",
              "additionalInfo": "string",
              "prices": [
                [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ]
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            }]
          },
          "termsConditions": {
            "minimumFeeRate": "string",
            "additionalInfo": "string",
            "elegibilityCriteriaInfo": "string",
            "closingProcessInfo": "string"
          }
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Marca selecionada pelas Organizações
companies [PersonalCreditCardCompanies] Sim Lista de instituições pertencentes a marca

PersonalCreditCardCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "personalCreditCards": [
    {
      "name": "string",
      "identification": {
        "product": {
          "type": "string",
          "additionalInfo": "string"
        },
        "creditCard": {
          "network": "string",
          "additionalInfo": "string"
        }
      },
      "rewardsProgram": {
        "hasRewardProgram": "string",
        "rewardProgramInfo": "string"
      },
      "fees": [
        {
          "service": {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "interest": {
        "feeRate": {
          "prices": [
            [
              {
                "interval": "string",
                "rate": "string"
              }
            ]
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        },
        "instalmentRate": {
          "prices": [
            [
              {
                "interval": "string",
                "rate": "string"
              }
            ]
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        },
        "interestRates": [{
          "code": "string",
          "additionalInfo": "string",
          "prices": [
            [
              {
                "interval": "string",
                "rate": "string"
              }
            ]
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        }]
      },
      "termsConditions": {
        "minimumFeeRate": "string",
        "additionalInfo": "string",
        "elegibilityCriteriaInfo": "string",
        "closingProcessInfo": "string"
      }
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da instituição financeira
cnpjNumber string Sim CNPJ da instituição financeira
urlComplementaryList string Não URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber
personalCreditCards [PersonalCreditCard] Sim Lista de cartões de crédito

PersonalCreditCard

{
  "name": "string",
  "identification": {
    "product": {
      "type": "string",
      "additionalInfo": "string"
    },
    "creditCard": {
      "network": "string",
      "additionalInfo": "string"
    }
  },
  "rewardsProgram": {
    "hasRewardProgram": "string",
    "rewardProgramInfo": "string"
  },
  "fees": [
    {
      "service": {
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "interest": {
    "feeRate": {
      "prices": [
        [
          {
            "interval": "string",
            "rate": "string"
          }
        ]
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    },
    "instalmentRate": {
      "prices": [
        [
          {
            "interval": "string",
            "rate": "string"
          }
        ]
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    },
    "interestRates": [{
      "code": "string",
      "additionalInfo": "string",
      "prices": [
        [
          {
            "interval": "string",
            "rate": "string"
          }
        ]
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    }]
  },
  "termsConditions": {
    "minimumFeeRate": "string",
    "additionalInfo": "string",
    "elegibilityCriteriaInfo": "string",
    "closingProcessInfo": "string"
  }
}
Nome Tipo Obrigatório Definição
name string Sim Denominação/Identificação do nome da conta (cartão de crédito)
identification PersonalCreditCardIdentification Sim Informações de identificação do cartão de crédito
rewardsProgram PersonalCreditCardRewardProgram Sim Informações sobre programas de recompensa presentes no cartão de crédito
fees PersonalCreditCardFee Sim Informações sobre tarifas cobradas sobre o produto e serviços
interest PersonalCreditCardInterest Sim Informações sobre taxas de juros
termsConditions PersonalCreditCardTermsConditions Sim Informações sobre termos e condições para aquisição e cancelamento

PersonalCreditCardIdentification

{
  "product":{
    "type": "string",
    "additionalInfo": "string"
  },
  "creditCard":{
    "network": "string",
    "additionalInfo": "string",
  }
}
Nome Tipo Obrigatório Definição
product PersonalCreditCardIdentificationProduct Sim Categoria atribuída a um cartão de pagamento, sob uma certa denominação, que lhe agrega um conjunto de vantagens, diferenciando-o de acordo com o perfil do portador
creditCard PersonalCreditCardIdentificationCreditCard Sim Categoria de Bandeiras de Cartões de Crédito

PersonalCreditCardIdentificationProduct

{
  "type": "string",
  "additionalInfo": "string"
}
Nome Tipo Obrigatório Definição
type Enum PersonalCreditCardProductType Sim Categoria atribuída a um cartão de pagamento, sob uma certa denominação, que lhe agrega um conjunto de vantagens, diferenciando-o de acordo com o perfil do portador. Essa categoria é definida pelo BACEN e está contida no documento de nome 'Elaboração e Remessa de Informações Relativas aos Cartões de Pagamento Emissores'
additionalInfo string Sim Texto livre para especificar

Enum PersonalCreditCardProductType

Propriedade Código Definição
productType CLASSIC_NACIONAL Classic Nacional
productType CLASSIC_INTERNACIONAL Classic Internacional
productType GOLD Gold
productType PLATINUM Platinum
productType INFINITE Infinite
productType ELECTRON Electron
productType STANDARD_NACIONAL Standard Nacional
productType STANDARD_INTERNACIONAL Standard Internacional
productType ELETRONIC Classic Nacional
productType BLACK Classic Internacional
productType REDESHOP Gold
productType MAESTRO_MASTERCARD_MAESTRO Maestro Mastercard maestro
productType GREEN green
productType BLUE blue
productType BLUEBOX blue box
productType PROFISSIONAL_LIBERAL profissional liberal
productType CHEQUE_ELETRONICO cheque eletronico
productType CORPORATIVO corporativo
productType EMPRESARIAL Empresarial
productType COMPRAS compras
productType OUTROS outros

PersonalCreditCardIdentificationCreditCard

{
  "network": "string",
  "additionalInfo": "string",
}
Nome Tipo Obrigatório Definição
network Enum PersonalCreditCardBrandCode Sim Categoria de Bandeiras de Cartões. Bandeira é a detentora de todos os direitos e deveres da utilização da marca estampada no cartão, inclusive as bandeiras pertencentes aos emissores. Essas bandeiras estão definidas em documento do BACEN de nome 'Elaboração e Remessa de Informações Relativas aos Cartões de Pagamento Emissores'
additionalInfo string Sim Texto livre para especificar categoria de bandeira marcada como 'Outras'

Enum PersonalCreditCardBrandCode

Propriedade Código Definição
creditCardNetwork VISA Visa
creditCardNetwork MASTERCARD MasterCard
creditCardNetwork AMERICAN_EXPRESS American Express
creditCardNetwork DINERS_CLUB Diners Club
creditCardNetwork HIPERCARD Hipercard
creditCardNetwork BANDEIRA_PROPRIA Bandeira própria
creditCardNetwork CHEQUE_ELETRONICO Cheque Eletrônico
creditCardNetwork ELO Elo
creditCardNetwork OUTRAS Outras

PersonalCreditCardRewardProgram

{
  "hasRewardProgram": "boolean",
  "rewardProgramInfo": "string"
}
Nome Tipo Obrigatório Definição
hasRewardProgram boolean Sim Indicador da existência de programa de fidelidade/recompensa associado à conta
rewardProgramInfo string Não Informações de termos e condições do programa de fidelidade/recompensa. Pode ser informada a URL referente ao endereço onde constam as condições informadas

PersonalCreditCardFee

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
        {
          "interval": "string",
          "value": "string",
          "currency": "string"
        }
      ],
      "minimum": {
        "value": "string",
        "currency": "string"
      },
      "maximum": {
        "value": "string",
        "currency": "string"
      }
  }
}
Nome Tipo Obrigatório Definição
services [PersonalCreditCardService] Sim Informações de tarifas sobre serviços

PersonalCreditCardService

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "price": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
    "value": "string",
    "currency": "string"
  },
  "maximum": {
    "value": "string",
    "currency": "string"
  }
}
Nome Tipo Obrigatório Definição
name string Sim Nomes das Tarifas cobradas sobre Serviços relacionados à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa jurídica
code string Sim Fatos geradores de cobrança que incidem sobre as Modalidades de Contas de Pagamento Pós-Pagas informada, para pessoa jurídica.
chargingTriggerInfo string Sim Fatos geradores de cobrança que incidem sobre as Modalidades inforrmadas de Contas de Pagamento Pós-Pagas para pessoa jurídica
price [Price] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa jurídica
minimum [MinimumPrice] Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência. Este campo deve estar obrigatoriamente preenchido se não houver conteúdo para os itens: value, currency e type
maximum [MaximumPrice] Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência. Este campo deve estar obrigatoriamente preenchido se não houver conteúdo para os itens: value, currency e type

PersonalCreditCardInterest

{
  "feeRate": {
    "prices": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "instalmentRate": {
    "prices": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "interestRates": [{
    "code": "string",
    "additionalInfo": "string",
    "prices": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  }]
}
Nome Tipo Obrigatório Definição
feeRate PersonalCreditCardFeeRate Sim Percentual que corresponde a taxa aplicada para utilização de Crédito Rotativo
instalmentRate PersonalCreditCardInstalmentRate Sim Percentual que corresponde a taxa aplicada para pagamento parcelado do saldo devedor quando não realizado pagamento integral da fatura
interestRates PersonalCreditCardInterestRate Sim Percentual que corresponde a taxa aplicada para pagamento parcelado do saldo devedor quando não realizado pagamento integral da fatura

PersonalCreditCardInterestRate

{
  "code": "string",
  "additionalInfo": "string",
  "prices": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
code Enum PersonalCreditCardInterestRateCode Sim Lista de outras operações de crédito
additionalInfo string Sim Campo Texto para descrever outras operações de crédito marcadas como 'Outros'
prices [Rate] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa física
minimumRate String Sim Percentual mínimo cobrado para a taxa do crédito rotativo no mês de referência
maximumRate String Sim Percentual máximo cobrado para o pagamento parcelado do saldo devedor na fatura do mês de referência.

Enum PersonalCreditCardInterestRateCode

Propriedade Código Definição
code SAQUE_CREDITO Saque a crédito
code PAGAMENTO_CONTA Pagamento de contas
code OUTROS Outros

PersonalCreditCardFeeRate

{
  "prices": [
    {
      "interval": "string",
      "rate": "string",
      "frequency": "string"
    }
  ],
  "minimumRate" : "string",
  "maximumRate" : "string"
}
Nome Tipo Obrigatório Definição
prices [Rate] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa física
minimumRate String Sim Percentual mínimo cobrado para a taxa do crédito rotativo no mês de referência
maximumRate String Sim Percentual máximo cobrado para o pagamento parcelado do saldo devedor na fatura do mês de referência.

PersonalCreditCardInstalmentRate

{
  "prices": [
    {
      "interval": "string",
      "rate": "string",
      "frequency": "string"
    }
  ],
  "minimumRate" : "string",
  "maximumRate" : "string"
}
Nome Tipo Obrigatório Definição
prices [Rate] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa física
minimumRate String Sim Percentual mínimo cobrado para a taxa do crédito rotativo no mês de referência
maximumRate String Sim Percentual máximo cobrado para o pagamento parcelado do saldo devedor na fatura do mês de referência.

PersonalCreditCardTermsConditions

{
  "minimumFeeRate": "string",
  "additionalInfo": "string",
  "elegibilityCriteriaInfo": "string",
  "closingProcessInfo": "string"
}
Nome Tipo Obrigatório Definição
minimumFeeRate RateString Sim Percentual para pagamento mínimo sobre o saldo devedor da fatura
additionalInfo string Sim Campo aberto para detalhamento de taxas de juros
elegibilityCriteriaInfo string Sim Informação sobre as condições e critérios de elegibilidade do emissor do cartão. Pode ser informada a URL referente ao endereço onde constam as condições informadas
closingProcessInfo string Sim Descrição dos procedimentos para encerramento da conta pós paga. Pode ser informada a URL referente ao endereço onde constam as condições informadas

ResponseBusinessCreditCardsList

{
  "data": {
    "brand": {
      "name": "string",
      "companies": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "urlComplementaryList": "string",
          "businessCreditCards": [
            {
              "name": "string",
              "identification": {
                "product": {
                  "type": "string",
                  "additionalInfo": "string"
                },
                "creditCard": {
                  "network": "string",
                  "additionalInfo": "string"
                }
              },
              "rewardsProgram": {
                "hasRewardProgram": "string",
                "rewardProgramInfo": "string"
              },
              "fees": [
                {
                  "service": {
                    "name": "string",
                    "code": "string",
                    "chargingTriggerInfo": "string",
                    "prices": [
                      {
                        "interval": "string",
                        "value": "string",
                        "currency": "string"
                      }
                    ],
                    "minimum": {
                      "value": "string",
                      "currency": "string"
                    },
                    "maximum": {
                      "value": "string",
                      "currency": "string"
                    }
                  }
                }
              ],
              "interest": {
                "feeRate": {
                  "prices": [
                    [
                      {
                        "interval": "string",
                        "rate": "string"
                      }
                    ]
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                },
                "instalmentRate": {
                  "prices": [
                    [
                      {
                        "interval": "string",
                        "rate": "string"
                      }
                    ]
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                },
                "interestRates": [{
                  "code": "string",
                  "additionalInfo": "string",
                  "prices": [
                    [
                      {
                        "interval": "string",
                        "rate": "string"
                      }
                    ]
                  ],
                  "minimumRate": "string",
                  "maximumRate": "string"
                }]
              },
              "termsConditions": {
                "minimumFeeRate": "string",
                "additionalInfo": "string",
                "elegibilityCriteriaInfo": "string",
                "closingProcessInfo": "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 BusinessCreditCardBrand Sim Dados da Marca selecionada que fornecem produtos e serviços de cartões de crédito para pessoa jurídica
links LinksPaginated Sim
meta MetaPaginated Sim

BusinessCreditCardBrand

{
  "name": "string",
  "companies": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "urlComplementaryList": "string",
      "businessCreditCards": [
        {
          "name": "string",
          "identification": {
            "product": {
              "type": "string",
              "additionalInfo": "string"
            },
            "creditCard": {
              "network": "string",
              "additionalInfo": "string"
            }
          },
          "rewardsProgram": {
            "hasRewardProgram": "string",
            "rewardProgramInfo": "string"
          },
          "fees": [
            {
              "service": {
                "name": "string",
                "code": "string",
                "chargingTriggerInfo": "string",
                "prices": [
                  {
                    "interval": "string",
                    "value": "string",
                    "currency": "string"
                  }
                ],
                "minimum": {
                  "value": "string",
                  "currency": "string"
                },
                "maximum": {
                  "value": "string",
                  "currency": "string"
                }
              }
            }
          ],
          "interest": {
            "feeRate": {
              "prices": [
                [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ]
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            },
            "instalmentRate": {
              "prices": [
                [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ]
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            },
            "interestRates": [{
              "code": "string",
              "additionalInfo": "string",
              "prices": [
                [
                  {
                    "interval": "string",
                    "rate": "string"
                  }
                ]
              ],
              "minimumRate": "string",
              "maximumRate": "string"
            }]
          },
          "termsConditions": {
            "minimumFeeRate": "string",
            "additionalInfo": "string",
            "elegibilityCriteriaInfo": "string",
            "closingProcessInfo": "string"
          }
        }
      ]
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da Marca selecionada pelas Organizações
companies [BusinessCreditCardCompanies] Sim Lista de instituições pertencentes a marca

BusinessCreditCardCompanies

{
  "name": "string",
  "cnpjNumber": "string",
  "urlComplementaryList": "string",
  "businessCreditCards": [
    {
      "name": "string",
      "identification": {
        "product": {
          "type": "string",
          "additionalInfo": "string"
        },
        "creditCard": {
          "network": "string",
          "additionalInfo": "string"
        }
      },
      "rewardsProgram": {
        "hasRewardProgram": "string",
        "rewardProgramInfo": "string"
      },
      "fees": [
        {
          "service": {
            "name": "string",
            "code": "string",
            "chargingTriggerInfo": "string",
            "prices": [
              {
                "interval": "string",
                "value": "string",
                "currency": "string"
              }
            ],
            "minimum": {
              "value": "string",
              "currency": "string"
            },
            "maximum": {
              "value": "string",
              "currency": "string"
            }
          }
        }
      ],
      "interest": {
        "feeRate": {
          "prices": [
            [
              {
                "interval": "string",
                "rate": "string"
              }
            ]
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        },
        "instalmentRate": {
          "prices": [
            [
              {
                "interval": "string",
                "rate": "string"
              }
            ]
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        },
        "interestRates": [{
          "code": "string",
          "additionalInfo": "string",
          "prices": [
            [
              {
                "interval": "string",
                "rate": "string"
              }
            ]
          ],
          "minimumRate": "string",
          "maximumRate": "string"
        }]
      },
      "termsConditions": {
        "minimumFeeRate": "string",
        "additionalInfo": "string",
        "elegibilityCriteriaInfo": "string",
        "closingProcessInfo": "string"
      }
    }
  ]
}
Nome Tipo Obrigatório Definição
name string Sim Nome da instituição financeira
cnpjNumber string Sim CNPJ da instituição financeira
urlComplementaryList string Não URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber
businessCreditCards [BusinessCreditCard] Sim Lista de cartões de crédito

BusinessCreditCard

{
  "name": "string",
  "identification": {
    "product": {
      "type": "string",
      "additionalInfo": "string"
    },
    "creditCard": {
      "network": "string",
      "additionalInfo": "string"
    }
  },
  "rewardsProgram": {
    "hasRewardProgram": "string",
    "rewardProgramInfo": "string"
  },
  "fees": [
    {
      "service": {
        "name": "string",
        "code": "string",
        "chargingTriggerInfo": "string",
        "prices": [
          {
            "interval": "string",
            "value": "string",
            "currency": "string"
          }
        ],
        "minimum": {
          "value": "string",
          "currency": "string"
        },
        "maximum": {
          "value": "string",
          "currency": "string"
        }
      }
    }
  ],
  "interest": {
    "feeRate": {
      "prices": [
        [
          {
            "interval": "string",
            "rate": "string"
          }
        ]
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    },
    "instalmentRate": {
      "prices": [
        [
          {
            "interval": "string",
            "rate": "string"
          }
        ]
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    },
    "interestRates": [{
      "code": "string",
      "additionalInfo": "string",
      "prices": [
        [
          {
            "interval": "string",
            "rate": "string"
          }
        ]
      ],
      "minimumRate": "string",
      "maximumRate": "string"
    }]
  },
  "termsConditions": {
    "minimumFeeRate": "string",
    "additionalInfo": "string",
    "elegibilityCriteriaInfo": "string",
    "closingProcessInfo": "string"
  }
}
Nome Tipo Obrigatório Definição
name string Sim Denominação/Identificação do nome da conta (cartão de crédito)
identification BusinessCreditCardIdentification Sim Informações de identificação do cartão de crédito
rewardsProgram BusinessCreditCardRewardProgram Sim Informações sobre programas de recompensa presentes no cartão de crédito
fees BusinessCreditCardFee Sim Informações sobre tarifas cobradas sobre o produto e serviços
interest BusinessCreditCardInterest Sim Informações sobre taxas de juros
termsConditions BusinessCreditCardTermsConditions Sim Informações sobre termos e condições para aquisição e cancelamento

BusinessCreditCardIdentification

{
  "product":{
    "type": "string",
    "additionalInfo": "string"
  },
  "creditCard":{
    "network": "string",
    "additionalInfo": "string",
  }
}
Nome Tipo Obrigatório Definição
product BusinessCreditCardIdentificationProduct Sim Categoria atribuída a um cartão de pagamento, sob uma certa denominação, que lhe agrega um conjunto de vantagens, diferenciando-o de acordo com o perfil do portador
creditCard BusinessCreditCardIdentificationCreditCard Sim Categoria de Bandeiras de Cartões de Crédito

BusinessCreditCardIdentificationProduct

{
  "type": "string",
  "additionalInfo": "string"
}
Nome Tipo Obrigatório Definição
type Enum BusinessCreditCardProductType Sim Categoria atribuída a um cartão de pagamento, sob uma certa denominação, que lhe agrega um conjunto de vantagens, diferenciando-o de acordo com o perfil do portador. Essa categoria é definida pelo BACEN e está contida no documento de nome 'Elaboração e Remessa de Informações Relativas aos Cartões de Pagamento Emissores'
additionalInfo string Sim Texto livre para especificar

Enum BusinessCreditCardProductType

Propriedade Código Definição
productType CLASSIC_NACIONAL Classic Nacional
productType CLASSIC_INTERNACIONAL Classic Internacional
productType GOLD Gold
productType PLATINUM Platinum
productType INFINITE Infinite
productType ELECTRON Electron
productType STANDARD_NACIONAL Standard Nacional
productType STANDARD_INTERNACIONAL Standard Internacional
productType ELETRONIC Classic Nacional
productType BLACK Classic Internacional
productType REDESHOP Gold
productType MAESTRO_MASTERCARD_MAESTRO Maestro Mastercard maestro
productType GREEN green
productType BLUE blue
productType BLUEBOX blue box
productType PROFISSIONAL_LIBERAL profissional liberal
productType CHEQUE_ELETRONICO cheque eletronico
productType CORPORATIVO corporativo
productType EMPRESARIAL Empresarial
productType COMPRAS compras
productType OUTROS outros

BusinessCreditCardIdentificationCreditCard

{
  "network": "string",
  "additionalInfo": "string",
}
Nome Tipo Obrigatório Definição
network Enum BusinessCreditCardBrandCode Sim Categoria de Bandeiras de Cartões. Bandeira é a detentora de todos os direitos e deveres da utilização da marca estampada no cartão, inclusive as bandeiras pertencentes aos emissores. Essas bandeiras estão definidas em documento do BACEN de nome 'Elaboração e Remessa de Informações Relativas aos Cartões de Pagamento Emissores'
additionalInfo string Sim Texto livre para especificar categoria de bandeira marcada como 'Outras'

Enum BusinessCreditCardBrandCode

Propriedade Código Definição
creditCardNetwork VISA Visa
creditCardNetwork MASTERCARD MasterCard
creditCardNetwork AMERICAN_EXPRESS American Express
creditCardNetwork DINERS_CLUB Diners Club
creditCardNetwork HIPERCARD Hipercard
creditCardNetwork BANDEIRA_PROPRIA Bandeira própria
creditCardNetwork CHEQUE_ELETRONICO Cheque Eletrônico
creditCardNetwork ELO Elo
creditCardNetwork OUTRAS Outras

BusinessCreditCardRewardProgram

{
  "hasRewardProgram": "boolean",
  "rewardProgramInfo": "string"
}
Nome Tipo Obrigatório Definição
hasRewardProgram boolean Sim Indicador da existência de programa de fidelidade/recompensa associado à conta
rewardProgramInfo string Não Informações de termos e condições do programa de fidelidade/recompensa. Pode ser informada a URL referente ao endereço onde constam as condições informadas

BusinessCreditCardFee

{
  "service": {
    "name": "string",
    "code": "string",
    "chargingTriggerInfo": "string",
    "prices": [
        {
          "interval": "string",
          "value": "string",
          "currency": "string"
        }
      ],
      "minimum": {
        "value": "string",
        "currency": "string"
      },
      "maximum": {
        "value": "string",
        "currency": "string"
      }
  }
}
Nome Tipo Obrigatório Definição
services [BusinessCreditCardService] Sim Informações de tarifas sobre serviços

BusinessCreditCardService

{
  "name": "string",
  "code": "string",
  "chargingTriggerInfo": "string",
  "price": [
    {
      "interval": "string",
      "value": "string",
      "currency": "string"
    }
  ],
  "minimum": {
    "value": "string",
    "currency": "string"
  },
  "maximum": {
    "value": "string",
    "currency": "string"
  }
}
Nome Tipo Obrigatório Definição
name string Sim Nomes das Tarifas cobradas sobre Serviços relacionados à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa jurídica
code string Sim Fatos geradores de cobrança que incidem sobre as Modalidades de Contas de Pagamento Pós-Pagas informada, para pessoa jurídica.
chargingTriggerInfo string Sim Fatos geradores de cobrança que incidem sobre as Modalidades inforrmadas de Contas de Pagamento Pós-Pagas para pessoa jurídica
price [Price] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa jurídica
minimum [MinimumPrice] Sim Valor mínimo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência. Este campo deve estar obrigatoriamente preenchido se não houver conteúdo para os itens: value, currency e type
maximum [MaximumPrice] Sim Valor máximo cobrado para a taxa de remuneração relativa ao serviço ofertado sobre a base de clientes no mês de referência. Este campo deve estar obrigatoriamente preenchido se não houver conteúdo para os itens: value, currency e type

BusinessCreditCardInterest

{
  "feeRate": {
    "prices": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "instalmentRate": {
    "prices": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  },
  "interestRates": [{
    "code": "string",
    "additionalInfo": "string",
    "prices": [
      {
        "interval": "string",
        "rate": "string"
      }
    ],
    "minimumRate": "string",
    "maximumRate": "string"
  }]
}
Nome Tipo Obrigatório Definição
feeRate BusinessCreditCardFeeRate Sim Percentual que corresponde a taxa aplicada para utilização de Crédito Rotativo
instalmentRate BusinessCreditCardInstalmentRate Sim Percentual que corresponde a taxa aplicada para pagamento parcelado do saldo devedor quando não realizado pagamento integral da fatura
interestRates BusinessCreditCardInterestRate Sim Percentual que corresponde a taxa aplicada para pagamento parcelado do saldo devedor quando não realizado pagamento integral da fatura

BusinessCreditCardInterestRate

{
  "code": "string",
  "additionalInfo": "string",
  "prices": [
    {
      "interval": "string",
      "rate": "string"
    }
  ],
  "minimumRate": "string",
  "maximumRate": "string"
}
Nome Tipo Obrigatório Definição
code Enum BusinessCreditCardInterestRateCode Sim Lista de outras operações de crédito
additionalInfo string Sim Campo Texto para descrever outras operações de crédito marcadas como 'Outros'
prices [Rate] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa física
minimumRate String Sim Percentual mínimo cobrado para a taxa do crédito rotativo no mês de referência
maximumRate String Sim Percentual máximo cobrado para o pagamento parcelado do saldo devedor na fatura do mês de referência.

Enum BusinessCreditCardInterestRateCode

Propriedade Código Definição
code SAQUE_CREDITO Saque a crédito
code PAGAMENTO_CONTA Pagamento de contas
code OUTROS Outros

BusinessCreditCardFeeRate

{
  "prices": [
    {
      "interval": "string",
      "rate": "string",
      "frequency": "string"
    }
  ],
  "minimumRate" : "string",
  "maximumRate" : "string"
}
Nome Tipo Obrigatório Definição
prices [Rate] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa física
minimumRate String Sim Percentual mínimo cobrado para a taxa do crédito rotativo no mês de referência
maximumRate String Sim Percentual máximo cobrado para o pagamento parcelado do saldo devedor na fatura do mês de referência.

BusinessCreditCardInstalmentRate

{
  "prices": [
    {
      "interval": "string",
      "rate": "string",
      "frequency": "string"
    }
  ],
  "minimumRate" : "string",
  "maximumRate" : "string"
}
Nome Tipo Obrigatório Definição
prices [Rate] Sim Informações sobre a tarifa cobrada, relativa ao serviço relacionado à Modalidade informada de Contas de Pagamento Pós-Pagas para pessoa física
minimumRate String Sim Percentual mínimo cobrado para a taxa do crédito rotativo no mês de referência
maximumRate String Sim Percentual máximo cobrado para o pagamento parcelado do saldo devedor na fatura do mês de referência.

BusinessCreditCardTermsConditions

{
  "minimumFeeRate": "string",
  "additionalInfo": "string",
  "elegibilityCriteriaInfo": "string",
  "closingProcessInfo": "string"
}
Nome Tipo Obrigatório Definição
minimumFeeRate RateString Sim Percentual para pagamento mínimo sobre o saldo devedor da fatura
additionalInfo string Sim Campo aberto para detalhamento de taxas de juros
elegibilityCriteriaInfo string Sim Informação sobre as condições e critérios de elegibilidade do emissor do cartão. Pode ser informada a URL referente ao endereço onde constam as condições informadas
closingProcessInfo string Sim Descrição dos procedimentos para encerramento da conta pós paga. Pode ser informada a URL referente ao endereço onde constam as condições informadas

ResponseDiscoveryStatusList

{
  "data": {
      "status": "string",
      "explanation": "string",
      "detectionTime": "string",
      "expectedResolutionTime": "string",
      "updateTime": "string",
      "unavailableEndpoints": object
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}
Nome Tipo Obrigatório Definição
data [DiscoveryStatus] Sim Lista de códigos de status da API.
links LinksPaginated Sim
meta MetaPaginated Sim

DiscoveryStatus

{
  "status": "string",
  "explanation": "string",
  "detectionTime": "string",
  "expectedResolutionTime": "string",
  "updateTime": "string",
  "unavailableEndpoints": object
}
Nome Tipo Obrigatório Definição
» status String Sim Enum com Status da API. OK (a implementação é totalmente funcional). PARTIAL_FAILURE (um ou mais endpoints estão indisponíveis). UNAVAILABLE (a implementação completa está indisponível). SCHEDULED_OUTAGE (uma interrupção anunciada está em vigor.)
» explanation String Sim Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Obrigatório se a propriedade status tiver algum valor que não seja OK.
» detectionTime DateTimeString Não A data e hora em que a interrupção atual foi detectada. Só deve estar presente se a propriedade status for PARTIAL_FAILURE ou UNAVAILABLE.
» expectedResolutionTime DateTimeString Não A data e hora em que o serviço completo deve continuar (se conhecido). Não deve estar presente se a propriedade status tiver um valor OK.
» updateTime DateTimeString Não A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.
unavailableEndpoints object Não Endpoints com indisponibilidade

Valores do Enum

Propriedade Valor
Status OK
Status PARTIAL_FAILURE
Status UNAVAILABLE
Status SCHEDULED_OUTAGE

ResponseDiscoveryOutagesList

{
  "data": {
    "outages": [
      {
        "outageTime": "string",
        "duration": "string",
        "isPartial": boolean,
        "explanation": "string",
        "unavailableEndpoints": object
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}
Nome Tipo Obrigatório Definição
data object Sim
outages [DiscoveryOutage] Sim Lista de indisponibilidades planejadas.
links LinksPaginated Sim
meta MetaPaginated Sim

DiscoveryOutage

{
  "outageTime": "string",
  "duration": "string",
  "isPartial": boolean,
  "explanation": "string",
  "unavailableEndpoints": object
}
Nome Tipo Obrigatório Definição
outageTime DateTimeString Sim Data e hora planejada do início da indisponibilidade.
duration DurationString Sim Duração prevista da indisponibilidade.
isPartial Boolean Não Flag que indica se a indisponibilidade é parcial (atingindo apenas alguns endpoints) ou total (atingindo todos os endpoints).
explanation String Sim Explicação sobre os motivos da indisponibilidade.
unavailableEndpoints object Não Endpoints com indisponibilidade

ResponseMetricsList

{
  "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
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "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": {}
}
Nome Tipo Obrigatório Definição
data object Sim
» requestTime DateTimeString Sim Data e hora que as métricas foram requisitadas.
» availability AvailabilityMetrics Sim Índices de disponibilidades das APIs.
» invocations InvocationMetrics Sim Número de chamadas em cada em cada nível e prioridade.
» averageResponse AverageMetrics Sim Tempo médio de reposta em segundos em cada nível e prioridade.
» averageTps AverageTPSMetrics Sim Transações em média por segundo.
» peakTps PeakTPSMetrics Sim Número máximo de transações por segundo.
» errors ErrorMetrics Sim Número de chamadas que resultaram em erro devido ao servidor.
» rejections RejectionMetrics Sim Número de chamadas rejeitadas devido aos limites.
links Links Sim
meta Meta Não

AvailabilityMetrics

{
  "uptime" : {
      "generalUptimeRate" : "",
      "endpoints" : [
          {
              "url" : "",
              "uptimeRate" : ""
          }
      ]
  },
  "downtime" : {
      "generalDowntime" : 0,
      "scheduledOutage" : 0,
      "endpoints" : [
          {
              "url" : "",
              "partialDowntime" : 0
          }
      ]
  }
}
Nome Tipo Obrigatório Definição
uptime object Sim Tempos de uptime por endpoint
» generalUptimeRate RateString Sim Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo).
» endpoints [EndpointUptime] Sim Tempos de uptime por endpoint.
downtime object Sim Tempos de downtime por endpoint.
» generalDowntime number Sim Quantidade de segundos de downtime (considerando qualquer api em downtime).
» scheduledOutage number Sim Quantidade de segundos de indisponibilidade agendada.
» endpoints [EndpointDowntime] Sim Tempos de downtime por endpoint.

EndpointUptime

{
  "url" : "",
  "uptimeRate" : ""
}
Nome Tipo Obrigatório Definição
url string Sim URL do endpoint
uptimeRate RateString Sim Taxa de disponibilidade do endpoint.

EndpointDowntime

{
  "url" : "",
  "partialDowntime" : 0
}
Nome Tipo Obrigatório Definição
url string Sim URL do endpoint
partialDowntime number Sim Quantidade de segundos de indisponibilidade do endpoint.

InvocationMetrics

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "lowPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
}
Nome Tipo Obrigatório Definição
unauthenticated object Sim Número de chamadas não autenticadas.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority object Sim Número de chamadas para o nível de alta prioridade.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
lowPriority object Sim Número de chamadas para o nível de baixa prioridade.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended object Sim Número de chamadas para o nível não acompanhado.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

AverageMetrics

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "lowPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
}
Nome Tipo Obrigatório Definição
unauthenticated object Sim Número de chamadas não autenticadas.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority object Sim Número de chamadas para o nível de alta prioridade.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
lowPriority object Sim Número de chamadas para o nível de baixa prioridade.
» currentDay number Sim Número de chamadas no dia atual
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended object Sim Número de chamadas para o nível não acompanhado.
» currentDay number Sim Número de chamadas no dia atual.
» previousDays [number] Sim Número de chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

AverageTPSMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}
Nome Tipo Obrigatório Definição
currentDay number Sim Número médio de chamadas por segundo no dia.
previousDays [number] Sim Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

PeakTPSMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}
Nome Tipo Obrigatório Definição
currentDay number Sim Pico de chamadas por segundo no dia
previousDays [number] Sim Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

ErrorMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}
Nome Tipo Obrigatório Definição
currentDay number Sim Número de chamadas com erro no dia atual.
previousDays [number] Sim Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

RejectionMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}
Nome Tipo Obrigatório Definição
currentDay number Sim Número de chamadas rejeitadas no dia atual.
previousDays [number] Sim Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

LinksPaginated

Nome Tipo Definição Mandatoriedade Restrição
self [URIString] URI completo que gerou a resposta atual. Mandatório
first [URIString] URI da primeira página que originou essa lista de resultados. Opcional Obrigatório quando não for a primeira página da resposta
prev [URIString] URI da página anterior dessa lista de resultados. Opcional Obrigatório quando não for a primeira página da resposta
next [URIString] URI da próxima página dessa lista de resultados. Opcional Obrigatório quando não for a última página da resposta
last [URIString] URI da última página dessa lista de resultados. Opcional Obrigatório quando não for a última página da resposta

MetaPaginated

Nome Tipo Definição Mandatoriedade Restrição
totalRecords integer Número total de registros no resultado Mandatório
totalPages integer Número total de páginas no resultado Mandatório

MetaPaginated

Nome Tipo Definição Mandatoriedade Restrição
totalRecords integer Número total de registros no resultado. Mandatório
totalPages integer Número total de páginas no resultado. Mandatório

Enum PriceInterval

Nome Código Definição
interval 1_QUARTIL_CLIENTES 1ª Quartil de clientes
interval 2_QUARTIL_CLIENTES 2ª Quartil de clientes
interval 3_QUARTIL_CLIENTES 3ª Quartil de clientes
interval 4_QUARTIL_CLIENTES 4ª Quartil de clientes

Price

{
  "interval": "string",
  "value": "string",
  "currency": "string"
}
Nome Tipo Obrigatório Definição
interval Enum PriceInterval Sim Faixas de valor referentes a tarifa do Serviço informada: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes
value AmountString Sim Valor da mediana da tarifa cobrada, relativa ao Serviço, para o tipo de faixa informada.
currency CurrencyString Sim Moeda referente ao valor da Tarifa, segundo modelo ISO-4217. p.ex. 'BRL'

MinimumPrice

{
  "value": "string",
  "currency": "string"
}
Nome Tipo Obrigatório Definição
value AmountString Sim Valor mínimo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência
currency CurrencyString Sim Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217. p.ex.'BRL'

MaximumPrice

{
  "value": "string",
  "currency": "string"
}
Nome Tipo Obrigatório Definição
value AmountString Sim Valor máximo cobrado para a tarifa de serviços sobre a base de clientes no mês de referência
currency CurrencyString Sim Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217. p.ex.'BRL'

MinimumRate

{
"minimumRate": "string"
}
Nome Tipo Obrigatório Definição
minimumRate string Sim Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado

MaximumRate

{
"maximumRate": "string"
}
Nome Tipo Obrigatório Definição
maximumRate string Sim Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado

Rate

{
  "interval": "string",
  "rate": "string"
}
Nome Tipo Obrigatório Definição
interval Enum PriceInterval Sim Faixas para a cobrança da taxa de utilização do crédito rotativo, no intervalo informado: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes.
rate RateString Sim Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do Empréstimo, no intervalo informado. p.ex. '9,8700%'. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)

Application

{
  "interval": "string",
  "rate": "string"
}
Nome Tipo Obrigatório Definição
interval Enum PriceInterval Sim Faixas para cobrança da taxa efetiva aplicada pela contratação do Empréstimo, no intervalo informado: 1º quartil de clientes, 2º quartil de clientes, 3º quartil de clientes e 4º quartil de clientes
rate RateString Sim Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do Empréstimo, no intervalo informado. p.ex. '9,8700%'. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)

Requisitos não funcionais

Nível de serviço (SLA)

O suporte eficaz da disponibilidade do Open Banking mantém níveis consistentes de serviços do sistema. Níveis de Serviço definidos:

Informativamente, esse nível de serviço representa aproximadamente um downtime máximo de 0,5% por trimestre, o que corresponde a 18s por hora, 7,2min (432s) por dia, 3,6h (216m) por mês e 10,8h (648m) por trimestre.

A definição de um período de indisponibilidade é qualquer período de tempo em que qualquer um dos endpoints da API definidos na norma é incapaz de fornecer uma resposta confiável a uma solicitação construída de forma apropriada.

Checagem de disponibilidade:

A disponibilidade é checada no endpoint GET /discovery/status, conforme documentada no item API de Status.

A cada 30 segundos, a API de status é requisitada com timeout de 1s.

O downtime deve ser calculado como o número total de segundos simultâneos por requisição da API, por período de 24 horas, começando e terminando à meia-noite, que qualquer endpoint da API não esteja disponível, dividido por 86.400 (total de segundos em 24 horas) e expresso como uma porcentagem.

A disponibilidade é calculada sendo 100% menos a quantidade em percentual da indisponibilidade.

Não será considerado como downtime:

Nível de desempenho

O desempenho do endpoint da API será medido no tempo de resposta de cada solicitação, desde o recebimento da solicitação até a entrega da resposta.
Espera-se que o detentor dos dados garanta que a medição do tempo de resposta ocorra o mais próximo possível do receptor dos dados, embora algumas camadas técnicas não estejam no controle do detentor dos dados.
À luz destas considerações, a exigência de desempenho para os detentores dos dados é:

P. ex. Em um dia que a API Produtos e Serviços receba 10.000 chamadas, pelo menos 9.500 delas deveriam ter sido respondidas dentro de um prazo inferior a 1500ms.

Limites de tráfego de requisições

Os limites de tráfego serão estabelecidos utilizando as seguintes métricas:

Cada instituição transmissora, deverá garantir os seguintes limites mínimos de tráfego abaixo especificados para as APIs de Dados Públicos – Fase 1, os quais serão revisados e ajustados em decorrência dos indicadores de uso das APIs, com revisão prevista imediatamente antes da entrada da Fase 2:

As chamadas que excedam os seguintes limites de tráfego poderão ser enfileiradas ou rejeitadas por um detentor de dados sem impacto em seu desempenho ou requisitos de disponibilidade.

Requisições que ultrapassem os limites estabelecidos poderão ser rejeitadas utilizando o HTTP status code:429 Too Many Requests.

Guia Operacional

O Guia Operacional dá suporte a doadores e receptores, trazendo informações sobre Desempenho, Disponibilidade, Processo de Registro e Revogação, Estrutura do Repositório de Informações, Resolução de Problemas, Comunicação de Mudanças, CheckList, Glossário e Referências.

Ele poderá ser acessado clicando aqui.

Guia de Versionamento

Este anexo tem como objetivo detalhar quando mudanças nas APIs do Open Banking serão consideradas disruptivas (breaking changes) exigindo a criação de uma nova versão maior (major) e quando uma mudança poderá ser tratada como não disruptiva (non breaking changes) podendo ser criada uma versão menor (minor) para comportá-la.

Mudanças em APIs REST podem ocorrer no contrato da API (Open API 3.0) tendo efeitos mais visíveis aos consumidores e, portanto, sendo mais fácil de se mapear os seus impactos; ou podem acontecer em suas regras de negócio/implementação precisando de uma análise mais complexa de quando a mudança traz impactos aos atuais consumidores das APIs.

Nota: Os exemplos contidos neste anexo são meramente ilustrativos e não refletem as APIs definidas nas especificações do Open Banking.

Ele poderá ser acessado clicando aqui.