You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
aRepositório para documentação e requisitos das APIs regulatórias do Open Banking Brasil.
6
+
7
+
## O que é?
8
+
9
+
O Open Banking, ou sistema financeiro aberto, é a possibilidade de clientes de produtos e serviços financeiros permitirem o compartilhamento de suas informações entre diferentes instituições autorizadas pelo Banco Central e a movimentação de suas contas bancárias a partir de diferentes plataformas e não apenas pelo aplicativo ou site do banco, de forma segura, ágil e conveniente.
10
+
11
+
Mais informações em: https://www.bcb.gov.br/estabilidadefinanceira/openbanking
12
+
5
13
6
14
## Diretórios
7
15
8
16
-### / swagger-apis
9
-
Contains the last versions and the older versions of specifications (OAS 3.0) of Open Banking APIs.
10
-
-### / dictionary
11
-
Contains the dictionaries of last APIs versions.
17
+
Contém as ultimas versões e as versões anteriores das especificações (OAS 3.0) das APIs do Open Banking.
Representante legal - Nome Civil completo da Pessoa Natural que represente uma entidade ou uma empresa e é nomeado em seu ato constitutivo, ou seja, no contrato social ou estatuto social.
22
22
Procurador - é qualquer pessoa que represente a Pessoa Natural em algum negócio, mediante autorização escrita do mesmo.";Texto;19;Obrigatório;;"REPRESENTANTE_LEGAL
/data/procurators/cpfNumber;cpfNumber;Número completo do CPF. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal;Texto;11;Obrigatório;^\d{11}$|^NA$;;1;1;"";Não permitido;string;73677831148
26
26
/data/procurators/civilName;civilName;Nome civil completo da pessoa natural. (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte);Texto;70;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Elza Milena Stefany Teixeira
27
27
/data/procurators/socialName;socialName;Nome social da pessoa natural, se houver. (aquele pelo qual travestis e transexuais se reconhecem, bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Nº 51.180, de 14 de janeiro de 2010);Texto;70;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Carlos
/data/investmentConditions/minimumAmount;minimumAmount;Valor mínimo de aplicação no ativo.;Texto;19;Obrigatório;^\d{1,16}\.\d{2}$;;1;1;"";Não permitido;string;100.00
38
38
/data/investmentConditions/redemptionTerm;redemptionTerm;Capacidade de conversão do título em dinheiro (resgate ou recompra).<br><br><ol><li>diária</li><li>na data de vencimento</li><li>diária após prazo de carência</li></ol>;Texto;29;Obrigatório;;"DIARIA
/data/investmentConditions/minimumExpirationTerm;minimumExpirationTerm;Prazo mínimo referente ao vencimento do título;Número;;Obrigatório;;;1;1;"";Não permitido;number;30
42
42
/data/investmentConditions/maximumExpirationTerm;maximumExpirationTerm;Prazo máximo referente ao vencimento do título;Número;;Obrigatório;;;1;1;"";Não permitido;number;720
43
43
/data/investmentConditions/minimumGracePeriod;minimumGracePeriod;Prazo mínimo da carência, ou seja, quando passa a ser possível resgatar o investimento;Número;;Obrigatório;;;1;1;"";Não permitido;number;5
Copy file name to clipboardexpand all lines: dictionary/investmentsGetFunds_v1.csv
+7-3
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,12 @@
8
8
/data/name;name;Nome oficial do fundo de investimento.;Texto;250;Obrigatório;;;1;1;"";Não permitido;string;FUNDO DE INVESTIMENTO EM COTAS DE FUNDOS DE INVESTIMENTO
9
9
/data/cnpjNumber;cnpjNumber;CNPJ do fundo de investimento.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;64108803000191
10
10
/data/isinCode;isinCode;"Código universal que identifica cada valor mobiliário ou instrumento financeiro, conforme Norma ISO 6166.<br><br>DEFINIÇÃO:O ISIN (International Securities Identification Number) é um código que identifica um valor mobiliário, conforme a norma ISO 6166.<br>ESTRUTURA<br>O ISIN é um código alfanumérico que possui 12 caracteres com a seguinte estrutura:<ul><li>um prefixo, composto de 2 caracteres alfa, que identifica o código do país (Norma ISO 3166);</li><li>o número básico, composto de 9 caracteres alfabéticos ou numéricos em sua extensão;</li><li>um dígito numérico de controle.</li></ul>";Texto;12;Opcional;^[A-Z]{2}([A-Z0-9]){9}\d{1}$;;0;1;"";Não permitido;string;BRAAAAAAA000
/data/admin/name;name;Razão social da pessoa jurídica autorizada pela CVM para o exercício de administrador de carteiras de valores mobiliários e responsável pela administração do fundo.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;ADM OPEN BANKING DTVM S.A.
13
+
/data/admin/cnpjNumber;cnpjNumber;CNPJ do administrador.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;14511732000150
/data/fundManager/name;name;Pessoa natural ou jurídica responsável pela gestão profissional dos ativos da carteira de valores mobiliários autorizado pela CVM.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;GESTOR OPEN BANKING DTVM S.A.
16
+
/data/fundManager/cnpjNumber;cnpjNumber;CNPJ do gestor do fundo de investimento.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;16332711000101
13
17
/data/anbimaCategory;anbimaCategory;Conforme classificação ANBIMA, que segue a deliberação 77 da ANBIMA.<br><ol><li>Renda Fixa</li><li>Ações</li><li>Multimercado</li><li>Cambial</li></ol><br><br>;Texto;12;Obrigatório;;"RENDA_FIXA
/data/generalConditions/minimumAmount/value;value;Valor mínimo do primeiro aporte.;Texto;19;Obrigatório;^\d{1,16}\.\d{2}$;;1;1;"";Não permitido;string;100000.12
58
-
/data/generalConditions/minimumAmount/currency;currency;Moeda referente ao valor da transação, segundo modelo ISO-4217. p.ex. 'BRL'<br>Todos os saldos informados estão representados com a moeda vigente do Brasil;Texto;;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL
62
+
/data/generalConditions/minimumAmount/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL
/data/generalConditions/redemption/quotationDays;quotationDays;Prazo em dias indicada no regulamento do fundo para a conversão das cotas em dinheiro.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;3
61
65
/data/generalConditions/redemption/quotationTerm;quotationTerm;Período em dias corridos ou dias úteis do prazo de cotização.<br><br><ol><li>Dias corridos</li><li>Dias úteis</li></ol>;Texto;13;Obrigatório;;"DIAS_CORRIDOS
Copy file name to clipboardexpand all lines: dictionary/paymentsGetConsentsConsentId_v1.csv
+40-12
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,46 @@ Para o cenário em que o status assumiu AUTHORISED, o tempo máximo do expiratio
9
9
O tempo do expirationDateTime é garantido com os 15 minutos do access token, sendo possível utilizar mais três refresh tokens até totalizar 60 minutos.";Date Hora;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z
10
10
/data/statusUpdateDateTime;statusUpdateDateTime;Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z
11
11
/data/status;status;"Retorna o estado do consentimento, o qual no momento de sua criação será AWAITING_AUTHORISATION.
12
-
Este estado será alterado depois da autorização do consentimento na detentora da conta do pagador (Debtor) para AUTHORISED ou REJECTED.
13
-
O consentimento fica no estado CONSUMED após ocorrer a iniciação do pagamento referente ao consentimento.
14
-
Em caso de consentimento expirado a detentora deverá retornar o status REJECTED.
/data/loggedUser;loggedUser;Usuário (pessoa natural) que encontra-se logado na instituição Iniciadora de Pagamento.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
/data/revocation;revocation;Objeto que contém as informações das circunstância da revogação.;Objeto;;Condicional;;;0;1;" O campo loggedUser deve ser preenchido quando a revogação for feita pelo usuário final, ou seja, se o campo data.revocation.revokedBy estiver com o valor 'USER'.
27
+
";Não permitido;object;
28
+
/data/revocation/loggedUser;loggedUser;Usuário (pessoa natural) que encontra-se logado na instituição Iniciadora de Pagamento.;Objeto;;Condicional;;;0;1;" Deve obrigatoriamente ser enviado quando a revogação for feita pelo usuário final, ou seja, se o campo revokedBy estiver com o valor 'USER'.
29
+
";Não permitido;object;
30
+
/data/revocation/loggedUser/document;document;Objeto que contém os dados de identificação do usuário.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
31
+
/data/revocation/loggedUser/document/identification;identification;Número do documento de identificação oficial do usuário.;Texto;11;Obrigatório;^\d{11}$;;1;1;"";Não permitido;string;11111111111
32
+
/data/revocation/loggedUser/document/rel;rel;Tipo do documento de identificação oficial do usuário.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;CPF
33
+
/data/revocation/revokedBy;revokedBy;"Define qual das partes envolvidas na transação está realizando a revogação. Valores possíveis:
34
+
- USER (Revogado pelo usuário)
35
+
- ASPSP (Provedor de serviços de pagamento para serviços de conta - Detentora de conta)
36
+
- TPP (Instituições Provedoras - iniciadora de pagamentos)";Texto;8;Obrigatório;;"USER
37
+
ASPSP
38
+
TPP";1;1;"";Não permitido;string;USER
39
+
/data/revocation/reason;reason;Define a razão pela qual o consentimento foi revogado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
40
+
/data/revocation/reason/code;code;"Define o código da razão pela qual o consentimento foi revogado.
41
+
Valores possíveis:
42
+
FRAUD - Indica suspeita de fraude
43
+
ACCOUNT_CLOSURE - Indica que a conta do usuário foi encerrada
44
+
OTHER - Indica que motivo do cancelamento está fora dos motivos pré-estabelecidos.";Texto;22;Obrigatório;;"FRAUD
45
+
ACCOUNT_CLOSURE
46
+
OTHER";1;1;"";Não permitido;string;OTHER
47
+
/data/revocation/reason/additionalInformation;additionalInformation;Contém informações adicionais definidas pelo requisitante da revogação.;Texto;140;Condicional;[\w\W\s]*;;0;1;" Deverá ser obrigatoriamente preenchido quando a revogação for feita pela iniciadora ou pela detentora unilateralmente, ou seja, quando o campo revokedBy for igual a TPP ou ASPSP e o motivo de revogação for OTHER.
48
+
";Não permitido;string;Não quero mais o serviço
49
+
/data/loggedUser;loggedUser;Usuário (pessoa natural) que encontra-se logado na instituição Iniciadora de Pagamento.;Objeto;;Condicional;;;1;1;" Deve obrigatoriamente ser enviado quando a revogação for feita pelo usuário final, ou seja, se o campo revokedBy estiver com o valor 'USER'.
50
+
";Não permitido;object;
51
+
/data/loggedUser/document;document;Objeto que contém os dados de identificação do usuário.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
25
52
/data/loggedUser/document/identification;identification;Número do documento de identificação oficial do usuário.;Texto;11;Obrigatório;^\d{11}$;;1;1;"";Não permitido;string;11111111111
26
53
/data/loggedUser/document/rel;rel;Tipo do documento de identificação oficial do usuário.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;CPF
27
54
/data/businessEntity;businessEntity;Usuário (pessoa jurídica) que encontra-se logado na instituição Iniciadora de Pagamento.;Objeto;;Condicional;;;0;1; Preenchimento obrigatório se usuário logado na instituição Iniciadora de Pagamento for um CNPJ (pessoa jurídica).;Não permitido;object;
@@ -39,7 +66,8 @@ O CNPJ será utilizado com 14 números e deverá ser informado sem pontos ou tra
39
66
Em caso de pessoa jurídica deve ser informada a razão social ou o nome fantasia da conta do recebedor.";Texto;140;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Marco Antonio de Brito
40
67
/data/payment;payment;Objeto contendo dados de pagamento para consentimento.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
41
68
/data/payment/type;type;Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento.;Texto;3;Obrigatório;;PIX;1;1;"";Não permitido;string;PIX
42
-
/data/payment/date;date;Data do pagamento, conforme especificação RFC-3339.;Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-01-01
/data/payment/date;date;Mutuamente exclusivo com o objeto schedule. Este campo é obrigatório no caso de pagamento único. Neste caso, o objeto schedule não deve ser informado.;Data;10;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;0;1;"";Não permitido;string;2021-01-01
43
71
/data/payment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'.
44
72
Todos os valores monetários informados estão representados com a moeda vigente do Brasil.";Texto;3;Obrigatório;^([A-Z]{3})$;;1;1;"";Não permitido;string;BRL
45
73
/data/payment/amount;amount;Valor da transação com 2 casas decimais.;Texto;19;Obrigatório;^((\d{1,16}\.\d{2}))$;;1;1;"";Não permitido;string;100000.12
0 commit comments