Skip to content

Commit 1820838

Browse files
committed
arch(Portal): ORB-486 - Incluir dicionarios de dados das APIs de produçao, nova estrutura de pastas e arquivos e Swaggers das APIs de produçao no formato YAML
1 parent 4c30461 commit 1820838

File tree

281 files changed

+163545
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

281 files changed

+163545
-1
lines changed

.github/workflows/deploy.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Deploy
2+
on:
3+
push:
4+
branches:
5+
- "OPB_Homologacao"
6+
pull_request:
7+
branches:
8+
- "main"
9+
jobs:
10+
deploy:
11+
env:
12+
enable-deploy: ${{ github.ref_name == 'OPB_Homologacao' || (github.repository != 'Sensedia/areadesenvolvedor' && github.ref_name == 'main')}}
13+
name: Deploy Github pages
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
18+
- name: Deploy
19+
if: env.enable-deploy == 'true'
20+
uses: peaceiris/actions-gh-pages@v3
21+
with:
22+
github_token: ${{ secrets.GITHUB_TOKEN }}
23+
publish_dir: .
24+

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
1+
![Build](https://github.com/openbanking-brasil/draft-openapi/workflows/Build/badge.svg)
2+
![Stoplight](https://github.com/openbanking-brasil/draft-openapi/workflows/Stoplight/badge.svg)
13
# draft-openapi
2-
This repository provides the necessary support for API management in Draft an Release Candidate stages.
4+
This repository provides the necessary support for API management in Draft an Release Candidate stages
5+
6+
## Diretórios
7+
8+
- ### / 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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo
2+
/data;data;Conjunto de informações das Contas de: depósito à vista, poupança e de pagamento pré-paga;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
3+
/data/availableAmount;availableAmount;Saldo disponível para utilização imediata. No caso de conta de depósito a vista, sem considerar cheque especial e investimentos atrelados a conta. Admite saldo negativo. Expresso em valor monetário com 4 casas decimais.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Permitido;number;100000.04
4+
/data/availableAmountCurrency;availableAmountCurrency;Moeda referente ao valor do saldo disponível, segundo modelo ISO-4217. p.ex. 'BRL'. Pode ser preenchido com “NA” caso a instituição não possua a informação.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
5+
/data/blockedAmount;blockedAmount;Saldo bloqueado, não disponível para utilização imediata, por motivo de bloqueio apresentado para o cliente nos canais eletrônicos Expresso em valor monetário com 4 casas decimais.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Permitido;number;99.9999
6+
/data/blockedAmountCurrency;blockedAmountCurrency;Moeda referente ao valor do saldo bloqueado, segundo modelo ISO-4217. p.ex. 'BRL'. Pode ser preenchido com “NA” caso a instituição não possua a informação.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
7+
/data/automaticallyInvestedAmount;automaticallyInvestedAmount;Saldo disponível com aplicação automática - corresponde a soma do saldo disponível acrescido do valor obtido a partir da aplicação automática Expresso em valor monetário com 4 casas decimais.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Permitido;number;100000.04
8+
/data/automaticallyInvestedAmountCurrency;automaticallyInvestedAmountCurrency;Moeda referente ao valor do saldo disponível com aplicação automática, segundo modelo ISO-4217. p.ex. 'BRL'. Pode ser preenchido com “NA” caso a instituição não possua a informação.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo
2+
/data;data;Conjunto de informações da Conta de: depósito à vista;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
3+
/data/overdraftContractedLimit;overdraftContractedLimit;Valor do limite contratado do cheque especial.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Permitido;number;99.9999
4+
/data/overdraftContractedLimitCurrency;overdraftContractedLimitCurrency;Moeda referente ao valor do limite contratado do cheque especial, segundo modelo ISO-4217. p.ex. 'BRL'. Pode ser preenchido com “NA” caso a instituição não possua a informação.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
5+
/data/overdraftUsedLimit;overdraftUsedLimit;Valor utilizado total do limite do cheque especial e o adiantamento a depositante.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Permitido;number;10000.9999
6+
/data/overdraftUsedLimitCurrency;overdraftUsedLimitCurrency;Moeda referente ao valor utilizado total do limite do cheque especial e o adiantamento a depositante, segundo modelo ISO-4217. p.ex. 'BRL'. Pode ser preenchido com “NA” caso a instituição não possua a informação.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
7+
/data/unarrangedOverdraftAmount;unarrangedOverdraftAmount;Valor de operação contratada em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite pactuado de cheque especial.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Permitido;number;99.9999
8+
/data/unarrangedOverdraftAmountCurrency;unarrangedOverdraftAmountCurrency;Moeda referente ao valor de operação contratada em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite pactuado de cheque especial, segundo modelo ISO-4217. p.ex. 'BRL'. Pode ser preenchido com “NA” caso a instituição não possua a informação.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo
2+
/data;data;Lista dos lançamentos referentes às transações realizadas e de lançamentos futuros para as contas de: depósito à vista, poupança e de pagamento pré-paga;Lista;;Obrigatório;;;0;N;"";Não permitido;array;
3+
/data/transactionId;transactionId;Código ou identificador único prestado pela instituição que mantém a conta para representar a transação individual.;Texto;100;Opcional;^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$;;0;1;"";Não permitido;string;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl
4+
/data/completedAuthorisedPaymentType;completedAuthorisedPaymentType;"Indicador da transação:
5+
- Transação efetivada
6+
- Lançamento futuro";Texto;19;Obrigatório;;"TRANSACAO_EFETIVADA
7+
LANCAMENTO_FUTURO";1;1;"";Não permitido;string;TRANSACAO_EFETIVADA
8+
/data/creditDebitType;creditDebitType;"Indicador do tipo de lançamento:
9+
Débito (no extrato) Em um extrato bancário, os débitos, marcados com a letra “D” ao lado do valor registrado, informam as saídas de dinheiro na conta-corrente.
10+
Crédito (no extrato) Em um extrato bancário, os créditos, marcados com a letra “C” ao lado do valor registrado, informam as entradas de dinheiro na conta-corrente.";Texto;7;Obrigatório;;"CREDITO
11+
DEBITO";1;1;"";Não permitido;string;DEBITO
12+
/data/transactionName;transactionName;Campo livre que corresponde ao identificador da transação na instituição financeira;Texto;60;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;TRANSFCWAR5TXHCX5I9IDBHML8082N8NEO30M6LNNG7ANAYIJYRM00ZBZPU8
13+
/data/type;type;Tipo de Transação;Texto;31;Obrigatório;;"TED
14+
DOC
15+
PIX
16+
TRANSFERENCIA_MESMA_INSTITUICAO
17+
BOLETO
18+
CONVENIO_ARRECADACAO
19+
PACOTE_TARIFA_SERVICOS
20+
TARIFA_SERVICOS_AVULSOS
21+
FOLHA_PAGAMENTO
22+
DEPOSITO
23+
SAQUE
24+
CARTAO
25+
ENCARGOS_JUROS_CHEQUE_ESPECIAL
26+
RENDIMENTO_APLIC_FINANCEIRA
27+
PORTABILIDADE_SALARIO
28+
RESGATE_APLIC_FINANCEIRA
29+
OPERACAO_CREDITO
30+
OUTROS";1;1;"";Não permitido;string;PIX
31+
/data/amount;amount;Valor da transação. Expressa em valor monetário com 4 casas decimais.;Número;20;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;number;500.54
32+
/data/transactionCurrency;transactionCurrency;Moeda referente ao valor da transação, segundo modelo ISO-4217. p.ex. 'BRL'.;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL
33+
/data/transactionDate;transactionDate;"Se indicador de transação:
34+
TRANSACAO_EFETIVADA - corresponde a data de lançamento da transação
35+
LANCAMENTO_FUTURO - corresponde a data prevista de efetivação da transação";Texto;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-07
36+
/data/partieCnpjCpf;partieCnpjCpf;Identificação da pessoa envolvida na transação: pagador ou recebedor (Preencher com o CPF ou CNPJ, sem formatação);Texto;14;Obrigatório;^\d{11}$|^\d{14}$|^NA$;;1;1;"";Não permitido;string;43908445778
37+
/data/partiePersonType;partiePersonType;"Identificação do Tipo de Pessoa da pessoa envolvida na transação.
38+
Pessoa Natural - Informar CPF no campo “payerCnpjCpf”
39+
Pessoa Jurídica - Informar CNPJ no campo “payerCnpjCpf”";Texto;15;Obrigatório;;"PESSOA_NATURAL
40+
PESSOA_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL
41+
/data/partieCompeCode;partieCompeCode;Código identificador atribuído pelo Banco Central do Brasil às instituições participantes do STR (Sistema de Transferência de reservas) referente à pessoa envolvida na transação. O número-código substituiu o antigo código COMPE. Todos os participantes do STR, exceto as Infraestruturas do Mercado Financeiro (IMF) e a Secretaria do Tesouro Nacional, possuem um número-código independentemente de participarem da Centralizadora da Compensação de Cheques (Compe). O campo tem a anotação “n/a” (“não se aplica”) para os participantes do STR aos quais não é atribuído um número-código;Texto;3;Obrigatório;\d{3}|^NA$;;1;1;"";Não permitido;string;001
42+
/data/partieBranchCode;partieBranchCode;Código da Agência detentora da conta da pessoa envolvida na transação. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória);Texto;4;Obrigatório;\d{4}|^NA$;;1;1;"";Não permitido;string;6272
43+
/data/partieNumber;partieNumber;Número da conta da pessoa envolvida na transação;Texto;20;Obrigatório;^\d{8,20}$|^NA$;;1;1;"";Não permitido;string;67890854360
44+
/data/partieCheckDigit;partieCheckDigit;Dígito da conta da pessoa envolvida na transação;Texto;1;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo
2+
/data;data;Conjunto dos atributos que caracterizam as Contas de: depósito à vista, poupança e de pagamento pré-paga;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;
3+
/data/compeCode;compeCode;Código identificador atribuído pelo Banco Central do Brasil às instituições participantes do STR (Sistema de Transferência de reservas). O número-código substituiu o antigo código COMPE. Todos os participantes do STR, exceto as Infraestruturas do Mercado Financeiro (IMF) e a Secretaria do Tesouro Nacional, possuem um número-código independentemente de participarem da Centralizadora da Compensação de Cheques (Compe). O campo tem a anotação “n/a” (“não se aplica”) para os participantes do STR aos quais não é atribuído um número-código;Texto;3;Obrigatório;\d{3}|^NA$;;1;1;"";Não permitido;string;001
4+
/data/branchCode;branchCode;Código da Agência detentora da conta. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória);Texto;4;Obrigatório;\d{4}|^NA$;;1;1;"";Não permitido;string;6272
5+
/data/number;number;Número da conta;Texto;20;Obrigatório;^\d{8,20}$|^NA$;;1;1;"";Não permitido;string;24550245
6+
/data/checkDigit;checkDigit;Dígito da conta;Texto;1;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;4
7+
/data/type;type;"Tipos de contas. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Vide Enum
8+
Conta de depósito à vista ou 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
9+
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
10+
Conta de pagamento pré-paga: segundo CIRCULAR Nº 3.680, BCB de 2013, é a 'destinada à execução de transações de pagamento em moeda eletrônica realizadas com base em fundos denominados em reais previamente aportados'";Texto;24;Obrigatório;;"CONTA_DEPOSITO_A_VISTA
11+
CONTA_POUPANCA
12+
CONTA_PAGAMENTO_PRE_PAGA";1;1;"";Não permitido;string;CONTA_DEPOSITO_A_VISTA
13+
/data/subtype;subtype;"Subtipo de conta (vide Enum):
14+
Conta individual - possui um único titular
15+
Conta conjunta simples - onde as movimentações financeiras só podem serem realizadas mediante autorização de TODOS os correntistas da conta.
16+
Conta conjunta solidária - é a modalidade cujos titulares podem realizar movimentações de forma isolada, isto é, sem que seja necessária a autorização dos demais titulares";Texto;18;Obrigatório;;"INDIVIDUAL
17+
CONJUNTA_SIMPLES
18+
CONJUNTA_SOLIDARIA";1;1;"";Não permitido;string;INDIVIDUAL
19+
/data/currency;currency;"Moeda referente ao valor da transação, segundo modelo ISO-4217. p.ex. 'BRL'
20+
Todos os saldos informados estão representados com a moeda vigente do Brasil";Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL

dictionary/accountsGetAccounts_v1.csv

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo
2+
/data;data;Lista de contas depósito à vista, poupança e pagamento pré-pagas mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento;Lista;;Obrigatório;;;0;N;"";Não permitido;array;
3+
/data/brandName;brandName;Nome da Marca reportada pelo participante do Open Banking. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.;Texto;80;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Organização A
4+
/data/companyCnpj;companyCnpj;Número completo do CNPJ da instituição responsável pelo Cadastro - 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;Texto;14;Obrigatório;\d{14}|^NA$;;1;1;"";Não permitido;string;21128159000166
5+
/data/type;type;"Tipos de contas. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Vide Enum
6+
Conta de depósito à vista ou 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
7+
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
8+
Conta de pagamento pré-paga: segundo CIRCULAR Nº 3.680, BCB de 2013, é a 'destinada à execução de transações de pagamento em moeda eletrônica realizadas com base em fundos denominados em reais previamente aportados'";Texto;24;Obrigatório;;"CONTA_DEPOSITO_A_VISTA
9+
CONTA_POUPANCA
10+
CONTA_PAGAMENTO_PRE_PAGA";1;1;"";Não permitido;string;CONTA_DEPOSITO_A_VISTA
11+
/data/compeCode;compeCode;Código identificador atribuído pelo Banco Central do Brasil às instituições participantes do STR (Sistema de Transferência de reservas).O Compe (Sistema de Compensação de Cheques e Outros Papéis) é um sistema que identifica e processa as compensações bancárias. Ele é representado por um código de três dígitos que serve como identificador de bancos, sendo assim, cada instituição bancária possui um número exclusivo;Texto;3;Obrigatório;\d{3}|^NA$;;1;1;"";Não permitido;string;001
12+
/data/branchCode;branchCode;Código da Agência detentora da conta. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória);Texto;4;Obrigatório;\d{4}|^NA$;;1;1;"";Não permitido;string;6272
13+
/data/number;number;Número da conta;Texto;20;Obrigatório;^\d{8,20}$|^NA$;;1;1;"";Não permitido;string;94088392
14+
/data/checkDigit;checkDigit;Dígito da conta;Texto;1;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;4
15+
/data/accountId;accountId;Identifica de forma única a conta do cliente, mantendo as regras de imutabilidade dentro da instituição transmissora.;Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$;;1;1;"";Não permitido;string;92792126019929279212650822221989319252576

dictionary/accounts_balances.csv

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Xpath;Nome;Definição;Tipo de dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo Dado Json
2+
GET /accounts/{accountId}/balances;;Método para obter os saldos da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora;;;;;;;;;;
3+
data/;;Conjunto de informações das Contas de: depósito à vista, poupança e de pagamento pré-paga;Objeto;;Obrigatório;;;1;1;Não há restrição;;Objeto
4+
data/availableAmount;availableAmount;Saldo disponível para utilização imediata. No caso de conta de depósito a vista, sem considerar cheque especial e investimentos atrelados a conta. Admite saldo negativo. Expresso em valor monetário com 4 casas decimais;Número;19;Obrigatório;;;1;1;Não há restrição;Aceita nulo;Double
5+
data/availableAmountCurrency;availableAmountCurrency;Moeda referente ao valor do saldo disponível, segundo modelo ISO-4217. p.ex. 'BRL';Texto;3;Obrigatório;;;1;1;Pode ser preenchido com “NA” caso a instituição não possua a informação.;;String
6+
data/blockedAmount;blockedAmount;Saldo bloqueado, não disponível para utilização imediata, por motivo de bloqueio apresentado para o cliente nos canais eletrônicos Expresso em valor monetário com 4 casas decimais;Número;19;Obrigatório;;;1;1;Não há restrição;Aceita nulo;Double
7+
data/blockedAmountCurrency;blockedAmountCurrency;Moeda referente ao valor do saldo bloqueado, segundo modelo ISO-4217. p.ex. 'BRL';Texto;3;Obrigatório;;;1;1;Pode ser preenchido com “NA” caso a instituição não possua a informação.;;String
8+
data/automaticallyInvestedAmount;automaticallyInvestedAmount;Saldo disponível com aplicação automática - corresponde a soma do saldo disponível acrescido do valor obtido a partir da aplicação automática Expresso em valor monetário com 4 casas decimais;Número;19;Obrigatório;;;1;1;Não há restrição;Aceita nulo;Double
9+
data/automaticallyInvestedAmountCurrency;automaticallyInvestedAmountCurrency;Moeda referente ao valor do saldo disponível com aplicação automática, segundo modelo ISO-4217. p.ex. 'BRL';Texto;3;Obrigatório;;;1;1;Pode ser preenchido com “NA” caso a instituição não possua a informação.;;String

0 commit comments

Comments
 (0)