Merge pull request #2033 from Sensedia/GT-Dados-do-cliente-Atualizaca…

…o-branch-espelho Gt dados do cliente atualizacao branch espelho
Sensedia · Aug 11, 2023 · 1214d5a · 1214d5a
2 parents f1b3d35 + 22b7e0b
commit 1214d5a
Show file tree

Hide file tree

Showing 57 changed files with 27,022 additions and 194 deletions.
diff --git a/deprecated-swagger-components/_bank_fixed_incomes_apis_part.yml b/deprecated-swagger-components/_bank_fixed_incomes_apis_part.yml
@@ -3,7 +3,7 @@ info:
   title: API Bank Fixed Incomes - Open Finance Brasil
   description: |
     API de informações de operações de Renda Fixa Bancária Open Finance Brasil (Fase 4). API que retorna informações de operações de investimento do tipo Renda Fixa Bancária (CDB/RDB, LCI e LCA) mantidas nas instituições transmissoras por seus clientes, incluindo dados como denominação do produto, rentabilidade, quantidade, prazos, saldos em posição do cliente e movimentações financeiras. Não possui segregação entre pessoa natural e pessoa jurídica. Requer consentimento do cliente para todos os endpoints. A exposição se dará por cada operação de renda fixa contratada pelo cliente.
-  version: 1.0.0-rc1.0
+  version: 1.0.0-rc2.0
   license:
     name: Apache 2.0
     url: "https://www.apache.org/licenses/LICENSE-2.0"
@@ -24,9 +24,9 @@ tags:
   - name: Balances
     description: Obtém a posição da operação de Renda Fixa Bancária identificada por investmentId.
   - name: Transactions
-    description: Obtém as movimentações históricas (últimos 12 meses) da operação de Fundos de Investimento identificada por investmentId.
+    description: Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId.
   - name: Transactions Current
-    description: Obtém as movimentações recentes da operação de Fundos de Investimento identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
+    description: Obtém as movimentações recentes da operação de Renda Fixa Bancária identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
 
 paths:
   /investments:
@@ -75,11 +75,10 @@ paths:
         'default':
           $ref: '#/components/responses/DefaultWithAdditionalProperties'
       security:
-        - OpenId:
-            - 'openid'     
-          OAuth2Security:
-            - 'consent:consentId'
-            - 'bank-fixed-incomes' 
+        - OAuth2AuthorizationCode:
+          - openid
+          - consent:consentId
+          - bank-fixed-incomes
 
   /investments/{investmentId}:
     get:
@@ -125,11 +124,10 @@ paths:
         'default':
           $ref: '#/components/responses/DefaultWithAdditionalProperties'
       security:
-        - OpenId:
-            - 'openid'     
-          OAuth2Security:
-            - 'consent:consentId'
-            - 'bank-fixed-incomes' 
+        - OAuth2AuthorizationCode:
+          - openid
+          - consent:consentId
+          - bank-fixed-incomes
 
   /investments/{investmentId}/balances:
     get:
@@ -182,19 +180,18 @@ paths:
         'default':
           $ref: '#/components/responses/DefaultWithAdditionalProperties'
       security:
-        - OpenId:
-            - 'openid'     
-          OAuth2Security:
-            - 'consent:consentId'
-            - 'bank-fixed-incomes'        
+        - OAuth2AuthorizationCode:
+          - openid
+          - consent:consentId
+          - bank-fixed-incomes      
 
   /investments/{investmentId}/transactions:
     get:
       tags:
         - Transactions
-      summary: Obtém as movimentações históricas (últimos 12 meses) da operação de Fundos de Investimento identificada por investmentId.
+      summary: Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId.
       operationId: banktFixedIncomesGetInvestmentsInvestmentIdTransactions
-      description: Obtém as movimentações históricas (últimos 12 meses) da operação de Fundos de Investimento identificada por investmentId.
+      description: Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId.
       parameters:
        - $ref: '#/components/parameters/InvestmentId'
        - $ref: '#/components/parameters/Authorization'
@@ -237,19 +234,18 @@ paths:
         'default':
           $ref: '#/components/responses/TransactionsDefaultWithAdditionalProperties'
       security:
-        - OpenId:
-            - 'openid'     
-          OAuth2Security:
-            - 'consent:consentId'
-            - 'bank-fixed-incomes' 
+        - OAuth2AuthorizationCode:
+          - openid
+          - consent:consentId
+          - bank-fixed-incomes
 
   /investments/{investmentId}/transactions-current:
     get:
       tags:
         - Transactions Current
-      summary: Obtém as movimentações recentes da operação de Fundos de Investimento identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
+      summary: Obtém as movimentações recentes da operação de Renda Fixa Bancária identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
       operationId: banktFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent
-      description: Obtém as movimentações recentes da operação de Fundos de Investimento identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
+      description: Obtém as movimentações recentes da operação de Renda Fixa Bancária identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
       parameters:
        - $ref: '#/components/parameters/InvestmentId'
        - $ref: '#/components/parameters/Authorization'
@@ -292,11 +288,10 @@ paths:
         'default':
           $ref: '#/components/responses/TransactionsDefaultWithAdditionalProperties'
       security:
-        - OpenId:
-            - 'openid'     
-          OAuth2Security:
-            - 'consent:consentId'
-            - 'bank-fixed-incomes' 
+        - OAuth2AuthorizationCode:
+          - openid
+          - consent:consentId
+          - bank-fixed-incomes
 components:
   schemas:
     ResponseError:
@@ -315,8 +310,8 @@ components:
       $ref: ./schemas/bank_fixed_incomes_apis/IdentifyProduct.yaml
     EnumInvestmentType:
       $ref: ./schemas/bank_fixed_incomes_apis/EnumInvestmentType.yaml
-    EnumInvestmentsFixedIncomeBankIndexer:
-      $ref: ./schemas/enum/EnumInvestmentsFixedIncomeBankIndexer.yaml
+    EnumBankFixedIncomeIndexer:
+      $ref: ./schemas/bank_fixed_incomes_apis/EnumBankFixedIncomeIndexer.yaml
     Remuneration:
       $ref: ./schemas/bank_fixed_incomes_apis/Remuneration.yaml
     EnumRateType:
@@ -344,18 +339,15 @@ components:
     BalanceAmount:
       $ref: ./schemas/bank_fixed_incomes_apis/BankFixedIncomesBalancesAmount.yaml
   securitySchemes:
-    OpenId:
-      type: openIdConnect
-      openIdConnectUrl: 'https://auth.mockbank.poc.raidiam.io/.well-known/openid-configuration'
-    OAuth2Security:
+    OAuth2AuthorizationCode:
       type: oauth2
-      description: "Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Requer o processo de redirecionamento e autenticação do usuário a que se referem os dados."
+      description: Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Requer o processo de redirecionamento e autenticação do usuário a que se referem os dados.
       flows:
         authorizationCode:
-          authorizationUrl: "https://authserver.example/authorization"
-          tokenUrl: "https://authserver.example/token"
+          authorizationUrl: 'https://authserver.example/authorization'
+          tokenUrl: 'https://authserver.example/token'
           scopes:
-            bank_fixed_incomes: "Escopo necessário para acesso à API Bank Fixed Incomes. O controle dos endpoints específicos é feito via permissions."        
+            bank_fixed_incomes: Escopo necessário para acesso à API Bank Fixed Incomes. O controle dos endpoints específicos é feito via permissions.
   parameters:
     InvestmentId:
       $ref: ./parameters/InvestmentId.yaml

diff --git a/...d-swagger-components/schemas/bank_fixed_incomes_apis/BankFixedIncomesProductMovement.yaml b/...d-swagger-components/schemas/bank_fixed_incomes_apis/BankFixedIncomesProductMovement.yaml
@@ -13,7 +13,7 @@ properties:
     $ref: ./EnumBankFixedIncomeMovementType.yaml
   transactionType:
     $ref: ./EnumBankFixedIncomeTransactionType.yaml
-  typeAdditionalInfo:
+  trasanctionTypeAdditionalInfo:
     type: string
     maxLength: 100
     pattern: '[\w\W\s]*'

diff --git a/...ecated-swagger-components/schemas/bank_fixed_incomes_apis/EnumBankFixedIncomeIndexer.yaml b/...ecated-swagger-components/schemas/bank_fixed_incomes_apis/EnumBankFixedIncomeIndexer.yaml
@@ -0,0 +1,16 @@
+type: string
+description: Índice utilizado como referência para a correção da rentabilidade e/ou rendimentos do ativo (CDI, DI , TR, IPCA, IGP_M, IGP_DI, INPC, BCP, TLC, SELIC, PRE_FIXADO e OUTROS)
+enum:
+  - CDI
+  - DI
+  - TR
+  - IPCA
+  - IGP_M
+  - IGP_DI
+  - INPC
+  - BCP
+  - TLC
+  - SELIC
+  - PRE_FIXADO
+  - OUTROS
+example: CDI
diff --git a/deprecated-swagger-components/schemas/bank_fixed_incomes_apis/Remuneration.yaml b/deprecated-swagger-components/schemas/bank_fixed_incomes_apis/Remuneration.yaml
@@ -39,7 +39,7 @@ properties:
   calculation:
     $ref: ./EnumCalculation.yaml
   indexer:
-    $ref: ../enum/EnumInvestmentsFixedIncomeBankIndexer.yaml
+    $ref: ./EnumBankFixedIncomeIndexer.yaml
   indexerAdditionalInfo:
     type: string
     description: | 

diff --git a/deprecated-swagger-components/schemas/enum/EnumInvestmentsFixedIncomeBankIndexer.yaml b/deprecated-swagger-components/schemas/enum/EnumInvestmentsFixedIncomeBankIndexer.yaml
@@ -1,6 +1,6 @@
 type: string
 description: |
-  – Qualquer operação com taxa mista em CDI, DI, SELIC deverá ser ignorada - serão consideradas apenas taxas sem cupom  
+  – Qualquer operaçrão com taxa mista em CDI, DI, SELIC deverá ser ignorada - serão consideradas apenas taxas sem cupom  
   – No caso do pré-fixado será utilizado apenas o cupom, mesmo que haja outro indexador misturado  
   – No caso de TR, IPCA, IGP_M, IGP_DI, INPC, BCP, TLC E OUTROS, o cálculo será feito em cima do cupom (mesmo que ele seja zero), desconsiderando as operações que tenham indexador diferente de 100%
 

diff --git a/dictionary/banktFixedIncomesGetInvestmentsInvestmentIdBalances_v1.csv b/dictionary/banktFixedIncomesGetInvestmentsInvestmentIdBalances_v1.csv
@@ -11,27 +11,25 @@
 /data/netAmount;netAmount;Valor do investimento atualizado na data de referência, posterior a dedução de impostos (IOF e IR).;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/netAmount/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004;
 /data/netAmount/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
-/data/incomeTax;incomeTax;Valor do imposto considerando a alíquota vigente na data de referência.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/incomeTax;incomeTax;Valor do imposto de renda provisionado considerando a alíquota vigente na data de referência.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/incomeTax/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004;
 /data/incomeTax/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
-/data/financialTransactionTax;financialTransactionTax;Valor do imposto (IOF) considerando a alíquota vigente na data de referência.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/financialTransactionTax;financialTransactionTax;Valor do imposto (IOF) provisionado considerando a alíquota vigente na data de referência.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/financialTransactionTax/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004;
 /data/financialTransactionTax/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
-/data/blockedBalance;blockedBalance;Valor líquido não disponível para movimentação naquele momento por qualquer motivo (bloqueio judicial, bloqueio em garantia, entre outros).;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/blockedBalance;blockedBalance;Valor não disponível para movimentação naquele momento por qualquer motivo (bloqueio judicial, bloqueio em garantia, entre outros). Prazo de carência não é considerado como bloqueio.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/blockedBalance/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0004;
 /data/blockedBalance/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
 /data/purchaseUnitPrice;purchaseUnitPrice;Valor unitário negociado com o cliente na data de aquisição;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/purchaseUnitPrice/amount;amount;Valor relacionado ao objeto.;Texto;24;Obrigatório;^\d{1,15}\.\d{2,8}$;;1;1;"";Não permitido;string;1000.000004;
 /data/purchaseUnitPrice/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
-/data/preFixedRate;preFixedRate;"Taxa de remuneração acordada com o cliente na contratação. Em casos de produtos progressivos, considerar taxa vigente.  p.ex. 0.014500.
-O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros(representação de porcentagem p.ex: 0.150000. Este valor representa 15%. O valor 1 representa 100%).
-
-[Restrição] Campo de preenchimento obrigatório pelas participantes quando houver 'PRE_FIXADO' no campo 'indexer' ou quando se tratar de produto com remuneração híbrida.
-";Texto;8;Condicional;^\d{1}\.\d{6}$;;0;1;" Campo de preenchimento obrigatório pelas participantes quando houver 'PRE_FIXADO' no campo 'indexer' ou quando se tratar de produto com remuneração híbrida.
-";Não permitido;string;0.300000;8
-/data/postFixedIndexerPercentage;postFixedIndexerPercentage;"Percentual do indexador acordado com o  cliente na contratação. Em casos de produtos progressivos, considerar taxa vigente.  p.ex. 0.014500.
-O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros(representação de porcentagem p.ex: 0.150000. Este valor representa 15%. O valor 1 representa 100%).
-
-[Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'indexer' for preenchido de forma diferente de 'PRE_FIXADO' ou quando se tratar de produto com remuneração híbrida.
-";Texto;8;Condicional;^\d{1}\.\d{6}$;;0;1;" Campo de preenchimento obrigatório pelas participantes quando o campo 'indexer' for preenchido de forma diferente de 'PRE_FIXADO' ou quando se tratar de produto com remuneração híbrida.
-";Não permitido;string;1.000000;8
+/data/preFixedRate;preFixedRate;"Taxa de remuneração acordada com o cliente na contratação. 
+Em casos de produtos progressivos, considerar taxa vigente. p.ex. 0.014500. 
+O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros(representação de porcentagem p.ex: 0.150000. 
+Este valor representa 15%. O valor 1 representa 100%). É esperado que o preenchimento deste campo pelas participantes seja enviado de acordo com o campo preFixedRate do endpoint /investment/{investmentId}.
+";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.300000;8
+/data/postFixedIndexerPercentage;postFixedIndexerPercentage;"Percentual do indexador acordado com o cliente na contratação. 
+Em casos de produtos progressivos, considerar taxa vigente. p.ex. 0.014500. 
+O preenchimento deve respeitar as 6 casas decimais, mesmo que venham preenchidas com zeros(representação de porcentagem p.ex: 0.150000. 
+Este valor representa 15%. O valor 1 representa 100%). É esperado que o preenchimento deste campo pelas participantes seja enviado de acordo com o campo postFixedIndexerPercentage do endpoint /investment/{investmentId}.
+";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;1.000000;8
diff --git a/dictionary/banktFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv b/dictionary/banktFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
@@ -1,16 +1,24 @@
 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;Tamanho mínimo
 /data;data;;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
-/data/type;type;"Tipo de movimentação na visão de investimento (entrada ou saída) . (Nos casos de motivo de pagamento  ""pagamento de juros"" e ""amortização"", fica convencionado que será considerado que o tipo de movimento será saída).";Texto;;Obrigatório;;"ENTRADA 
+/data/type;type;"Tipo de movimentação na visão de investimento
+
+- ENTRADA: APLICACAO, CANCELAMENTO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.
+
+- SAIDA: RESGATE, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.
+
+Por exemplo, para movimentação de CANCELAMENTO, tipicamente, será o type contrário ao evento originário. Ou seja, para cancelamento de APLICACAO, considera-se type SAIDA; para cancelamento de RESGATE, considera-se type ENTRADA.
+";Texto;;Obrigatório;;"ENTRADA 
 SAIDA";1;1;"";Não permitido;string;ENTRADA;
-/data/transactionType;transactionType;Aplicação, resgate, cancelamento, vencimento, pagamento de juros/amortização, transferência de titularidade, transferência de custódia e outros.;Texto;;Obrigatório;;"APLICACAO 
+/data/transactionType;transactionType;Aplicação, resgate, cancelamento, vencimento, pagamento de juros, amortização, transferência de titularidade, transferência de custódia e outros. Para movimentos de transferência (titularidade ou custódia) deve ser considerado o preço unitário (transactionUnitPrice) da aquisição do título.;Texto;;Obrigatório;;"APLICACAO 
 RESGATE 
 CANCELAMENTO 
 VENCIMENTO 
-PAGAMENTO_JUROS_AMORTIZACAO 
+PAGAMENTO_JUROS 
+AMORTIZACAO 
 TRANSFERENCIA_TITULARIDADE 
 TRANSFERENCIA_CUSTODIA 
 OUTROS";1;1;"";Não permitido;string;APLICACAO;
-/data/typeAdditionalInfo;typeAdditionalInfo;"Informação adicional do tipo de movimentação, para preenchimento no caso de movimentações não delimitadas no domínio.
+/data/transactionTypeAdditionalInfo;transactionTypeAdditionalInfo;"Informação adicional do tipo de movimentação, para preenchimento no caso de movimentações não delimitadas no domínio.
 
 [Restrição] Campo de preenchimento obrigatório pelas participantes quando houver 'Outros' no campo Motivo da movimentação.
 ";Texto;100;Condicional;[\w\W\s]*;;0;1;" Campo de preenchimento obrigatório pelas participantes quando houver 'Outros' no campo Motivo da movimentação.
@@ -44,10 +52,10 @@ OUTROS";1;1;"";Não permitido;string;APLICACAO;
 
 [Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'ENTRADA'.
 ";Texto;8;Condicional;^\d{1}\.\d{6}$;;0;1;" Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'ENTRADA'.
-";Não permitido;string;0.300000;3
+";Não permitido;string;0.300000;8
 /data/indexerPercentage;indexerPercentage;"Percentual máximo do indexador acordado com o cliente na contratação.
 
 [Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'ENTRADA'.
 ";Texto;8;Condicional;^\d{1}\.\d{6}$;;0;1;" Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'ENTRADA'.
-";Não permitido;string;1.100000;3
+";Não permitido;string;1.100000;8
 /data/transactionId;transactionId;Código ou identificador único prestado pela instituição que mantém a representação individual do movimento.;Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;ABCD2126019929279212650822221989319253344;