From a795c51f5e042c88c09e02be8962aa9ff0b3d0a2 Mon Sep 17 00:00:00 2001 From: FelipeBaumgartel Date: Wed, 9 Aug 2023 10:17:17 -0300 Subject: [PATCH 1/2] feat(Opendata Credit Cards): ORB-3216 - PC146 - opendata-creditcards - Criar API --- dictionary/getBusinessCreditCards_v1.csv | 186 ++++ dictionary/getPersonalCreditCards_v1.csv | 186 ++++ swagger-apis/opendata-creditcards/1.0.0.yml | 921 +++++++++++++++++++ swagger-apis/opendata-creditcards/index.html | 81 ++ 4 files changed, 1374 insertions(+) create mode 100644 dictionary/getBusinessCreditCards_v1.csv create mode 100644 dictionary/getPersonalCreditCards_v1.csv create mode 100644 swagger-apis/opendata-creditcards/1.0.0.yml create mode 100644 swagger-apis/opendata-creditcards/index.html diff --git a/dictionary/getBusinessCreditCards_v1.csv b/dictionary/getBusinessCreditCards_v1.csv new file mode 100644 index 000000000..36da74406 --- /dev/null +++ b/dictionary/getBusinessCreditCards_v1.csv @@ -0,0 +1,186 @@ +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;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand;brand;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/name;name;Nome da Marca selecionada pelas Organizações;Texto;80;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Organização A; +/data/brand/companies;companies;Companies traz uma lista de todas as instituições da Marca;Lista;;Obrigatório;;;1;720;"";Não permitido;array;; +/data/brand/companies/name;name;Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A';Texto;80;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Empresa A1; +/data/brand/companies/cnpjNumber;cnpjNumber;CNPJ;Texto;14;Obrigatório;^(\d{14})$|^NA$;;1;1;"";Não permitido;string;50685362000135; +/data/brand/companies/urlComplementaryList;urlComplementaryList;"URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. +Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada +";Texto;1024;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;https://empresadaorganizacaoa.com/complementarylist; +/data/brand/companies/businessCreditCards;businessCreditCards;Lista dos nomes de conta de pagamento pós-paga;Lista;;Opcional;;;1;80;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/name;name;Denominação/Identificação do nome da conta (cartão de crédito);Texto;50;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Cartão Vantagens; +/data/brand/companies/businessCreditCards/identification;identification;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/identification/product;product;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/identification/product/type;type;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';Texto;;Obrigatório;;"CLASSIC_NACIONAL +CLASSIC_INTERNACIONAL +GOLD +PLATINUM +INFINITE +ELECTRON +STANDARD_NACIONAL +STANDARD_INTERNACIONAL +ELETRONIC +BLACK +REDESHOP +MAESTRO_MASTERCARD_MAESTRO +GREEN +BLUE +BLUEBOX +PROFISSIONAL_LIBERAL +CHEQUE_ELETRONICO +CORPORATIVO +EMPRESARIAL +COMPRAS +OUTROS";1;1;"";Não permitido;string;PLATINUM; +/data/brand/companies/businessCreditCards/identification/product/typeAdditionalInfo;typeAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao campo type. + +[Restrição] Obrigatório quando ""type” for igual “OUTROS“. +";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando ""type” for igual “OUTROS“. +";Não permitido;string;Informações adicionais; +/data/brand/companies/businessCreditCards/identification/creditCard;creditCard;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/identification/creditCard/network;network;"Categoria de Bandeiras de Cartões de Crédito (Instituidor do arranjo de pagamento). Bandeira é a detentora de todos os direitos e deveres da utilização da marca estampada no cartão, inclusive as bandeiras pertencentes aos emissores. p.ex. ""American Express"", ""Diners Club"" 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""";Texto;;Obrigatório;;"VISA +MASTERCARD +AMERICAN_EXPRESS +DINERS_CLUB +HIPERCARD +BANDEIRA_PROPRIA +CHEQUE_ELETRONICO +ELO +OUTRAS";1;1;"";Não permitido;string;MASTERCARD; +/data/brand/companies/businessCreditCards/identification/creditCard/networkAdditionalInfo;networkAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao campo network. + +[Restrição] Obrigatório quando ""network” for igual “OUTROS“. +";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando ""network” for igual “OUTROS“. +";Não permitido;string;Informações adicionais; +/data/brand/companies/businessCreditCards/rewardsProgram;rewardsProgram;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/rewardsProgram/hasRewardProgram;hasRewardProgram;Indicador da existência de programa de fidelidade/recompensa associado à conta de pagamento pós-paga (cartão) true false;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;false; +/data/brand/companies/businessCreditCards/rewardsProgram/rewardProgramInfo;rewardProgramInfo;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. Será de preenchimento obrigatório caso o campo hasRewardProgram esteja preenchido como true;Texto;2000;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;https://empresaa1.com/credit_cards_rewards; +/data/brand/companies/businessCreditCards/fees;fees;Objeto que reúne informações de tarifas de serviços;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/fees/services;services;Lista das Tarifas cobradas sobre Serviço relacionadas a Modalidade de Pagamento Pós-Pagas;Lista;;Obrigatório;;;1;9;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/fees/services/name;name;Denominação de Serviços relacionados à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM);Texto;;Obrigatório;;"ANUIDADE_CARTAO_BASICO_NACIONAL +ANUIDADE_CARTAO_BASICO_INTERNACIONAL +ANUIDADE_DIFERENCIADA +UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_BRASIL +UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_EXTERIOR +AVALIACAO_EMERGENCIAL_CREDITO +FORNECIMENTO_SEGUNDA_VIA_FUNCAO_CREDITO +PAGAMENTO_CONTAS_UTILIZANDO_FUNCAO_CREDITO +SMS";1;1;"";Não permitido;string;ANUIDADE_CARTAO_BASICO_NACIONAL; +/data/brand/companies/businessCreditCards/fees/services/code;code;Sigla de identificação do Serviço relacionado à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM);Texto;;Obrigatório;;"ANUIDADE_NACIONAL +ANUIDADE_INTERNACIONAL +ANUIDADE_DIFERENCIADA +SAQUE_CARTAO_BRASIL +SAQUE_CARTAO_EXTERIOR +AVALIACAO_EMERGENCIAL_CREDITO +EMISSAO_SEGUNDA_VIA +TARIFA_PAGAMENTO_CONTAS +SMS";1;1;"";Não permitido;string;ANUIDADE_NACIONAL; +/data/brand/companies/businessCreditCards/fees/services/chargingTriggerInfo;chargingTriggerInfo;Fatos geradores de cobrança que incidem sobre as Modalidades de Contas de Pagamento Pós-Pagas informada, para pessoa jurídica. (Campo Livre);Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;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; +/data/brand/companies/businessCreditCards/fees/services/prices;prices;Lista distribuição preços tarifas de serviços;Lista;;Obrigatório;;;4;4;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/fees/services/prices/interval;interval;"Segundo Normativa nº 32, BCB, de 2020: Distribuição de frequência relativa dos valores de tarifas cobradas dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana em cada uma dessas faixas. Informando: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa +";Texto;;Obrigatório;;"1_FAIXA +2_FAIXA +3_FAIXA +4_FAIXA";1;1;"";Não permitido;string;1_FAIXA; +/data/brand/companies/businessCreditCards/fees/services/prices/value;value;"Valor da mediana de cada faixa relativa ao serviço ofertado, informado no período, conforme Res nº 32 BCB, 2020. p.ex. '45.00' (representa um valor monetário. p.ex: 1547368.92. Este valor, considerando que a moeda seja BRL, significa R$ 1.547.368,92. O único separador presente deve ser o '.' (ponto) para indicar a casa decimal. Não deve haver separador de milhar) +";Texto;12;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;"";Não permitido;string;2000.00; +/data/brand/companies/businessCreditCards/fees/services/prices/currency;currency;Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL; +/data/brand/companies/businessCreditCards/fees/services/prices/customers;customers;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/fees/services/prices/customers/rate;rate;"Percentual de clientes em cada faixa. +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/businessCreditCards/fees/services/minimum;minimum;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/fees/services/minimum/value;value;Valor mínimo apurado para a tarifa de serviços sobre a base de clientes no mês de referência;Texto;12;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;"";Não permitido;string;1350.00; +/data/brand/companies/businessCreditCards/fees/services/minimum/currency;currency;Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL; +/data/brand/companies/businessCreditCards/fees/services/maximum;maximum;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/fees/services/maximum/value;value;Valor máximo apurado para a tarifa de serviços sobre a base de clientes no mês de referência;Texto;12;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;"";Não permitido;string;8800.00; +/data/brand/companies/businessCreditCards/fees/services/maximum/currency;currency;Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL; +/data/brand/companies/businessCreditCards/interest;interest;Informações sobre taxas de juros;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/interest/rates;rates;Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para crédito rotativo;Lista;;Obrigatório;;;1;20;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/interest/rates/referentialRateIndexer;referentialRateIndexer;"Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040 +";Texto;;Obrigatório;;"SEM_INDEXADOR_TAXA +PRE_FIXADO +POS_FIXADO_TR_TBF +POS_FIXADO_TJLP +POS_FIXADO_LIBOR +POS_FIXADO_TLP +OUTRAS_TAXAS_POS_FIXADAS +FLUTUANTES_CDI +FLUTUANTES_SELIC +OUTRAS_TAXAS_FLUTUANTES +INDICES_PRECOS_IGPM +INDICES_PRECOS_IPCA +INDICES_PRECOS_IPCC +OUTROS_INDICES_PRECO +CREDITO_RURAL_TCR_PRE +CREDITO_RURAL_TCR_POS +CREDITO_RURAL_TRFC_PRE +CREDITO_RURAL_TRFC_POS +OUTROS_INDEXADORES";1;1;"";Não permitido;string;SEM_INDEXADOR_TAXA; +/data/brand/companies/businessCreditCards/interest/rates/rate;rate;"Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). 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%) +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/businessCreditCards/interest/rates/applications;applications;Lista distribuição percentuais relativos à taxa de juros remuneratórios;Lista;;Obrigatório;;;4;4;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/interest/rates/applications/interval;interval;"Faixas para cobrança da taxa efetiva aplicada pela contratação do crédito, no intervalo informado: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa. Segundo Normativa nº32 de 2020: 'Distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas. +";Texto;;Obrigatório;;"1_FAIXA +2_FAIXA +3_FAIXA +4_FAIXA";1;1;"";Não permitido;string;; +/data/brand/companies/businessCreditCards/interest/rates/applications/indexer;indexer;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/interest/rates/applications/indexer/rate;rate;"Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,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%) +";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.870000;8 +/data/brand/companies/businessCreditCards/interest/rates/applications/customers;customers;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/interest/rates/applications/customers/rate;rate;"Percentual de clientes em cada faixa. +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/businessCreditCards/interest/rates/minimumRate;minimumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.045600;8 +/data/brand/companies/businessCreditCards/interest/rates/maximumRate;maximumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.686500;8 +/data/brand/companies/businessCreditCards/interest/instalmentRates;instalmentRates;Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para parcelamento do saldo devedor;Lista;;Obrigatório;;;1;20;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/interest/instalmentRates/referentialRateIndexer;referentialRateIndexer;"Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040 +";Texto;;Obrigatório;;"SEM_INDEXADOR_TAXA +PRE_FIXADO +POS_FIXADO_TR_TBF +POS_FIXADO_TJLP +POS_FIXADO_LIBOR +POS_FIXADO_TLP +OUTRAS_TAXAS_POS_FIXADAS +FLUTUANTES_CDI +FLUTUANTES_SELIC +OUTRAS_TAXAS_FLUTUANTES +INDICES_PRECOS_IGPM +INDICES_PRECOS_IPCA +INDICES_PRECOS_IPCC +OUTROS_INDICES_PRECO +CREDITO_RURAL_TCR_PRE +CREDITO_RURAL_TCR_POS +CREDITO_RURAL_TRFC_PRE +CREDITO_RURAL_TRFC_POS +OUTROS_INDEXADORES";1;1;"";Não permitido;string;SEM_INDEXADOR_TAXA; +/data/brand/companies/businessCreditCards/interest/instalmentRates/rate;rate;"Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). 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%) +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/businessCreditCards/interest/instalmentRates/applications;applications;Lista distribuição percentuais relativos à taxa de juros remuneratórios;Lista;;Obrigatório;;;4;4;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/interest/instalmentRates/applications/interval;interval;"Faixas para cobrança da taxa efetiva aplicada pela contratação do crédito, no intervalo informado: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa. Segundo Normativa nº32 de 2020: 'Distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas. +";Texto;;Obrigatório;;"1_FAIXA +2_FAIXA +3_FAIXA +4_FAIXA";1;1;"";Não permitido;string;; +/data/brand/companies/businessCreditCards/interest/instalmentRates/applications/indexer;indexer;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/interest/instalmentRates/applications/indexer/rate;rate;"Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,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%) +";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.870000;8 +/data/brand/companies/businessCreditCards/interest/instalmentRates/applications/customers;customers;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/interest/instalmentRates/applications/customers/rate;rate;"Percentual de clientes em cada faixa. +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/businessCreditCards/interest/instalmentRates/minimumRate;minimumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.045600;8 +/data/brand/companies/businessCreditCards/interest/instalmentRates/maximumRate;maximumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.686500;8 +/data/brand/companies/businessCreditCards/interest/otherCredits;otherCredits;Lista de outras operações de crédito;Lista;;Obrigatório;;;1;3;"";Não permitido;array;; +/data/brand/companies/businessCreditCards/interest/otherCredits/code;code;Lista de outras operações de crédito;Texto;;Obrigatório;;"SAQUE_A_CREDITO +PAGAMENTOS_CONTAS +OUTROS";1;1;"";Não permitido;string;SAQUE_A_CREDITO; +/data/brand/companies/businessCreditCards/interest/otherCredits/codeAdditionalInfo;codeAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao campo code. + +[Restrição] Obrigatório quando ""code ” for igual “OUTROS“. +";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando ""code ” for igual “OUTROS“. +";Não permitido;string;Informações adicionais; +/data/brand/companies/businessCreditCards/termsConditions;termsConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/businessCreditCards/termsConditions/minimumFeeRate;minimumFeeRate;Percentual para pagamento mínimo sobre o saldo devedor da fatura.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.250000;8 +/data/brand/companies/businessCreditCards/termsConditions/additionalInfo;additionalInfo;Campo aberto para detalhamento de taxas de juros;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;NA; +/data/brand/companies/businessCreditCards/termsConditions/elegibilityCriteriaInfo;elegibilityCriteriaInfo;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.;Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;https://empresaa1.com/creditcards_elegibility_criteria; +/data/brand/companies/businessCreditCards/termsConditions/closingProcessInfo;closingProcessInfo;Descrição dos procedimentos para encerramento da conta de pagamento pós paga. Pode ser informada a URL referente ao endereço onde constam as condições informadas.;Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;https://empresaa1.com/creditcards_closing_process; diff --git a/dictionary/getPersonalCreditCards_v1.csv b/dictionary/getPersonalCreditCards_v1.csv new file mode 100644 index 000000000..73d7b8768 --- /dev/null +++ b/dictionary/getPersonalCreditCards_v1.csv @@ -0,0 +1,186 @@ +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;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand;brand;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/name;name;Nome da Marca selecionada pelas Organizações;Texto;80;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Organização A; +/data/brand/companies;companies;Companies traz uma lista de todas as instituições da Marca;Lista;;Obrigatório;;;1;800;"";Não permitido;array;; +/data/brand/companies/name;name;Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A';Texto;80;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Empresa A1; +/data/brand/companies/cnpjNumber;cnpjNumber;CNPJ;Texto;14;Obrigatório;^(\d{14})$|^NA$;;1;1;"";Não permitido;string;50685362000135; +/data/brand/companies/urlComplementaryList;urlComplementaryList;"URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. +Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada +";Texto;1024;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;https://empresadaorganizacaoa.com/complementarylist; +/data/brand/companies/personalCreditCards;personalCreditCards;Lista das contas de pagamento pós-paga;Lista;;Obrigatório;;;1;300;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/name;name;Denominação/Identificação do nome da conta (cartão de crédito);Texto;50;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Cartão Universitário; +/data/brand/companies/personalCreditCards/identification;identification;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/identification/product;product;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/identification/product/type;type;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';Texto;;Obrigatório;;"CLASSIC_NACIONAL +CLASSIC_INTERNACIONAL +GOLD +PLATINUM +INFINITE +ELECTRON +STANDARD_NACIONAL +STANDARD_INTERNACIONAL +ELETRONIC +BLACK +REDESHOP +MAESTRO_MASTERCARD_MAESTRO +GREEN +BLUE +BLUEBOX +PROFISSIONAL_LIBERAL +CHEQUE_ELETRONICO +CORPORATIVO +EMPRESARIAL +COMPRAS +OUTROS";1;1;"";Não permitido;string;PLATINUM; +/data/brand/companies/personalCreditCards/identification/product/typeAdditionalInfo;typeAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao campo type. + +[Restrição] Obrigatório quando ""type” for igual “OUTROS“. +";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando ""type” for igual “OUTROS“. +";Não permitido;string;Informações adicionais; +/data/brand/companies/personalCreditCards/identification/creditCard;creditCard;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/identification/creditCard/network;network;"Categoria de Bandeiras de Cartões de Crédito (Instituidor do arranjo de pagamento). Bandeira é a detentora de todos os direitos e deveres da utilização da marca estampada no cartão, inclusive as bandeiras pertencentes aos emissores. p.ex. ""American Express"", ""Diners Club"" 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""";Texto;;Obrigatório;;"VISA +MASTERCARD +AMERICAN_EXPRESS +DINERS_CLUB +HIPERCARD +BANDEIRA_PROPRIA +CHEQUE_ELETRONICO +ELO +OUTRAS";1;1;"";Não permitido;string;MASTERCARD; +/data/brand/companies/personalCreditCards/identification/creditCard/networkAdditionalInfo;networkAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao campo network. + +[Restrição] Obrigatório quando ""network” for igual “OUTROS“. +";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando ""network” for igual “OUTROS“. +";Não permitido;string;Informações adicionais; +/data/brand/companies/personalCreditCards/rewardsProgram;rewardsProgram;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/rewardsProgram/hasRewardProgram;hasRewardProgram;Indicador da existência de programa de fidelidade/recompensa associado à conta de pagamento pós-paga (cartão) true false;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;false; +/data/brand/companies/personalCreditCards/rewardsProgram/rewardProgramInfo;rewardProgramInfo;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. Será de preenchimento obrigatório caso o campo hasRewardProgram esteja preenchido como true;Texto;2000;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;https://empresaa1.com/credit_cards_rewards; +/data/brand/companies/personalCreditCards/fees;fees;Objeto que reúne informações de tarifas de serviços;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/fees/services;services;Lista das Tarifas cobradas sobre Serviço relacionadas a Modalidade de Pagamento Pós-Pagas;Lista;;Obrigatório;;;1;9;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/fees/services/name;name;Denominação de Serviços relacionados à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM);Texto;;Obrigatório;;"ANUIDADE_CARTAO_BASICO_NACIONAL +ANUIDADE_CARTAO_BASICO_INTERNACIONAL +ANUIDADE_DIFERENCIADA +UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_BRASIL +UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_EXTERIOR +AVALIACAO_EMERGENCIAL_CREDITO +FORNECIMENTO_SEGUNDA_VIA_FUNCAO_CREDITO +PAGAMENTO_CONTAS_UTILIZANDO_FUNCAO_CREDITO +SMS";1;1;"";Não permitido;string;ANUIDADE_CARTAO_BASICO_NACIONAL; +/data/brand/companies/personalCreditCards/fees/services/code;code;Sigla de identificação do Serviço relacionado à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM);Texto;;Obrigatório;;"ANUIDADE_NACIONAL +ANUIDADE_INTERNACIONAL +ANUIDADE_DIFERENCIADA +SAQUE_CARTAO_BRASIL +SAQUE_CARTAO_EXTERIOR +AVALIACAO_EMERGENCIAL_CREDITO +EMISSAO_SEGUNDA_VIA +TARIFA_PAGAMENTO_CONTAS +SMS";1;1;"";Não permitido;string;ANUIDADE_NACIONAL; +/data/brand/companies/personalCreditCards/fees/services/chargingTriggerInfo;chargingTriggerInfo;Fatos geradores de cobrança que incidem sobre as Modalidades de Contas de Pagamento Pós-Pagas informada, para pessoa jurídica. (Campo Livre);Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;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; +/data/brand/companies/personalCreditCards/fees/services/prices;prices;Lista distribuição preços tarifas de serviços;Lista;;Obrigatório;;;4;4;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/fees/services/prices/interval;interval;"Segundo Normativa nº 32, BCB, de 2020: Distribuição de frequência relativa dos valores de tarifas cobradas dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana em cada uma dessas faixas. Informando: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa +";Texto;;Obrigatório;;"1_FAIXA +2_FAIXA +3_FAIXA +4_FAIXA";1;1;"";Não permitido;string;1_FAIXA; +/data/brand/companies/personalCreditCards/fees/services/prices/value;value;"Valor da mediana de cada faixa relativa ao serviço ofertado, informado no período, conforme Res nº 32 BCB, 2020. p.ex. '45.00' (representa um valor monetário. p.ex: 1547368.92. Este valor, considerando que a moeda seja BRL, significa R$ 1.547.368,92. O único separador presente deve ser o '.' (ponto) para indicar a casa decimal. Não deve haver separador de milhar) +";Texto;12;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;"";Não permitido;string;2000.00; +/data/brand/companies/personalCreditCards/fees/services/prices/currency;currency;Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL; +/data/brand/companies/personalCreditCards/fees/services/prices/customers;customers;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/fees/services/prices/customers/rate;rate;"Percentual de clientes em cada faixa. +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/personalCreditCards/fees/services/minimum;minimum;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/fees/services/minimum/value;value;Valor mínimo apurado para a tarifa de serviços sobre a base de clientes no mês de referência;Texto;12;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;"";Não permitido;string;1350.00; +/data/brand/companies/personalCreditCards/fees/services/minimum/currency;currency;Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL; +/data/brand/companies/personalCreditCards/fees/services/maximum;maximum;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/fees/services/maximum/value;value;Valor máximo apurado para a tarifa de serviços sobre a base de clientes no mês de referência;Texto;12;Obrigatório;^((\d{1,9}\.\d{2}){1}|NA)$;;1;1;"";Não permitido;string;8800.00; +/data/brand/companies/personalCreditCards/fees/services/maximum/currency;currency;Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL; +/data/brand/companies/personalCreditCards/interest;interest;Informações sobre taxas de juros;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/interest/rates;rates;Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para crédito rotativo;Lista;;Obrigatório;;;1;20;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/interest/rates/referentialRateIndexer;referentialRateIndexer;"Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040 +";Texto;;Obrigatório;;"SEM_INDEXADOR_TAXA +PRE_FIXADO +POS_FIXADO_TR_TBF +POS_FIXADO_TJLP +POS_FIXADO_LIBOR +POS_FIXADO_TLP +OUTRAS_TAXAS_POS_FIXADAS +FLUTUANTES_CDI +FLUTUANTES_SELIC +OUTRAS_TAXAS_FLUTUANTES +INDICES_PRECOS_IGPM +INDICES_PRECOS_IPCA +INDICES_PRECOS_IPCC +OUTROS_INDICES_PRECO +CREDITO_RURAL_TCR_PRE +CREDITO_RURAL_TCR_POS +CREDITO_RURAL_TRFC_PRE +CREDITO_RURAL_TRFC_POS +OUTROS_INDEXADORES";1;1;"";Não permitido;string;SEM_INDEXADOR_TAXA; +/data/brand/companies/personalCreditCards/interest/rates/rate;rate;"Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). 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%) +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/personalCreditCards/interest/rates/applications;applications;Lista distribuição percentuais relativos à taxa de juros remuneratórios;Lista;;Obrigatório;;;4;4;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/interest/rates/applications/interval;interval;"Faixas para cobrança da taxa efetiva aplicada pela contratação do crédito, no intervalo informado: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa. Segundo Normativa nº32 de 2020: 'Distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas. +";Texto;;Obrigatório;;"1_FAIXA +2_FAIXA +3_FAIXA +4_FAIXA";1;1;"";Não permitido;string;; +/data/brand/companies/personalCreditCards/interest/rates/applications/indexer;indexer;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/interest/rates/applications/indexer/rate;rate;"Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,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%) +";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.870000;8 +/data/brand/companies/personalCreditCards/interest/rates/applications/customers;customers;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/interest/rates/applications/customers/rate;rate;"Percentual de clientes em cada faixa. +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/personalCreditCards/interest/rates/minimumRate;minimumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.045600;8 +/data/brand/companies/personalCreditCards/interest/rates/maximumRate;maximumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.686500;8 +/data/brand/companies/personalCreditCards/interest/instalmentRates;instalmentRates;Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para parcelamento do saldo devedor;Lista;;Obrigatório;;;1;20;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/interest/instalmentRates/referentialRateIndexer;referentialRateIndexer;"Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040 +";Texto;;Obrigatório;;"SEM_INDEXADOR_TAXA +PRE_FIXADO +POS_FIXADO_TR_TBF +POS_FIXADO_TJLP +POS_FIXADO_LIBOR +POS_FIXADO_TLP +OUTRAS_TAXAS_POS_FIXADAS +FLUTUANTES_CDI +FLUTUANTES_SELIC +OUTRAS_TAXAS_FLUTUANTES +INDICES_PRECOS_IGPM +INDICES_PRECOS_IPCA +INDICES_PRECOS_IPCC +OUTROS_INDICES_PRECO +CREDITO_RURAL_TCR_PRE +CREDITO_RURAL_TCR_POS +CREDITO_RURAL_TRFC_PRE +CREDITO_RURAL_TRFC_POS +OUTROS_INDEXADORES";1;1;"";Não permitido;string;SEM_INDEXADOR_TAXA; +/data/brand/companies/personalCreditCards/interest/instalmentRates/rate;rate;"Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). 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%) +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/personalCreditCards/interest/instalmentRates/applications;applications;Lista distribuição percentuais relativos à taxa de juros remuneratórios;Lista;;Obrigatório;;;4;4;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/interest/instalmentRates/applications/interval;interval;"Faixas para cobrança da taxa efetiva aplicada pela contratação do crédito, no intervalo informado: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa. Segundo Normativa nº32 de 2020: 'Distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas. +";Texto;;Obrigatório;;"1_FAIXA +2_FAIXA +3_FAIXA +4_FAIXA";1;1;"";Não permitido;string;; +/data/brand/companies/personalCreditCards/interest/instalmentRates/applications/indexer;indexer;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/interest/instalmentRates/applications/indexer/rate;rate;"Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,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%) +";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.870000;8 +/data/brand/companies/personalCreditCards/interest/instalmentRates/applications/customers;customers;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/interest/instalmentRates/applications/customers/rate;rate;"Percentual de clientes em cada faixa. +";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.150000;8 +/data/brand/companies/personalCreditCards/interest/instalmentRates/minimumRate;minimumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.045600;8 +/data/brand/companies/personalCreditCards/interest/instalmentRates/maximumRate;maximumRate;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%);Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.686500;8 +/data/brand/companies/personalCreditCards/interest/otherCredits;otherCredits;Lista de outras operações de crédito;Lista;;Obrigatório;;;1;3;"";Não permitido;array;; +/data/brand/companies/personalCreditCards/interest/otherCredits/code;code;Lista de outras operações de crédito;Texto;;Obrigatório;;"SAQUE_A_CREDITO +PAGAMENTOS_CONTAS +OUTROS";1;1;"";Não permitido;string;SAQUE_A_CREDITO; +/data/brand/companies/personalCreditCards/interest/otherCredits/codeAdditionalInfo;codeAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao campo code. + +[Restrição] Obrigatório quando ""code ” for igual “OUTROS“. +";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando ""code ” for igual “OUTROS“. +";Não permitido;string;Informações adicionais; +/data/brand/companies/personalCreditCards/termsConditions;termsConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/brand/companies/personalCreditCards/termsConditions/minimumFeeRate;minimumFeeRate;Percentual para pagamento mínimo sobre o saldo devedor da fatura.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.250000;8 +/data/brand/companies/personalCreditCards/termsConditions/additionalInfo;additionalInfo;Campo aberto para detalhamento de taxas de juros;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;NA; +/data/brand/companies/personalCreditCards/termsConditions/elegibilityCriteriaInfo;elegibilityCriteriaInfo;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.;Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;https://empresaa1.com/creditcards_elegibility_criteria; +/data/brand/companies/personalCreditCards/termsConditions/closingProcessInfo;closingProcessInfo;Descrição dos procedimentos para encerramento da conta de pagamento pós paga. Pode ser informada a URL referente ao endereço onde constam as condições informadas.;Texto;2000;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;https://empresaa1.com/creditcards_closing_process; diff --git a/swagger-apis/opendata-creditcards/1.0.0.yml b/swagger-apis/opendata-creditcards/1.0.0.yml new file mode 100644 index 000000000..08b0a351b --- /dev/null +++ b/swagger-apis/opendata-creditcards/1.0.0.yml @@ -0,0 +1,921 @@ +openapi: 3.0.0 +info: + title: API OpenData Credit Cards do Open Finance Brasil + description: A API descrita neste documento é referente as API Credit Cards da fase OpenData do Open Finance Brasil. + version: 1.0.0 + contact: + url: 'https://servicedesk.openbankingbrasil.org.br/Login.jsp?navLanguage=pt-BR' +servers: + - url: 'http://api.banco.com.br/open-banking/products-services/v1' +tags: + - name: Credit Cards +paths: + /personal-credit-cards: + get: + tags: + - Credit Cards + summary: Obtém dados sobre cartões de crédito pessoa natural + description: Obtém dados sobre cartões de crédito pessoa natural + operationId: getPersonalCreditCards + parameters: + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/pageSize" + responses: + '200': + description: Dados sobre cartão de crédito pessoa natural obtidos com sucesso. + content: + application/json: + schema: + $ref: '#/components/schemas/PersonalCreditCardResponse' + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '504': + $ref: '#/components/responses/GatewayTimeout' + '529': + $ref: '#/components/responses/SiteIsOverloaded' + default: + $ref: '#/components/responses/Default' + /business-credit-cards: + get: + tags: + - Credit Cards + summary: Obtém dados sobre cartões de crédito pessoa jurídica + description: Obtém dados sobre cartões de crédito pessoa jurídica + operationId: getBusinessCreditCards + parameters: + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/pageSize" + responses: + '200': + description: Dados sobre cartões de crédito pessoa jurídica obtidos com sucesso. + content: + application/json: + schema: + $ref: '#/components/schemas/BusinessCreditCardResponse' + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + '504': + $ref: '#/components/responses/GatewayTimeout' + '529': + $ref: '#/components/responses/SiteIsOverloaded' + default: + $ref: '#/components/responses/Default' +components: + schemas: + ApplicationRate: + type: object + properties: + interval: + $ref: '#/components/schemas/ApplicationIntervals' + indexer: + $ref: '#/components/schemas/Indexer' + customers: + $ref: '#/components/schemas/Customer' + required: + - interval + - indexer + - customers + Indexer: + type: object + properties: + rate: + type: string + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 + description: | + Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,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%) + example: '0.870000' + PriceIntervals: + type: string + enum: + - 1_FAIXA + - 2_FAIXA + - 3_FAIXA + - 4_FAIXA + description: | + Segundo Normativa nº 32, BCB, de 2020: Distribuição de frequência relativa dos valores de tarifas cobradas dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana em cada uma dessas faixas. Informando: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa + example: 1_FAIXA + ApplicationIntervals: + type: string + enum: + - 1_FAIXA + - 2_FAIXA + - 3_FAIXA + - 4_FAIXA + description: | + Faixas para cobrança da taxa efetiva aplicada pela contratação do crédito, no intervalo informado: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa. Segundo Normativa nº32 de 2020: 'Distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas. + CreditCardIdentification: + type: object + required: + - product + - creditCard + properties: + product: + type: object + required: + - type + - additionalInfo + properties: + type: + type: string + enum: + - CLASSIC_NACIONAL + - CLASSIC_INTERNACIONAL + - GOLD + - PLATINUM + - INFINITE + - ELECTRON + - STANDARD_NACIONAL + - STANDARD_INTERNACIONAL + - ELETRONIC + - BLACK + - REDESHOP + - MAESTRO_MASTERCARD_MAESTRO + - GREEN + - BLUE + - BLUEBOX + - PROFISSIONAL_LIBERAL + - CHEQUE_ELETRONICO + - CORPORATIVO + - EMPRESARIAL + - COMPRAS + - OUTROS + description: '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''' + example: PLATINUM + typeAdditionalInfo: + type: string + maxLength: 140 + pattern: '[\w\W\s]*' + description: | + Campo livre para preenchimento das informações adicionais referente ao campo type. + + [Restrição] Obrigatório quando "type” for igual “OUTROS“. + example: 'Informações adicionais' + creditCard: + type: object + required: + - network + - additionalInfo + properties: + network: + type: string + enum: + - VISA + - MASTERCARD + - AMERICAN_EXPRESS + - DINERS_CLUB + - HIPERCARD + - BANDEIRA_PROPRIA + - CHEQUE_ELETRONICO + - ELO + - OUTRAS + description: 'Categoria de Bandeiras de Cartões de Crédito (Instituidor do arranjo de pagamento). Bandeira é a detentora de todos os direitos e deveres da utilização da marca estampada no cartão, inclusive as bandeiras pertencentes aos emissores. p.ex. "American Express", "Diners Club" 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"' + example: MASTERCARD + networkAdditionalInfo: + type: string + maxLength: 140 + pattern: '[\w\W\s]*' + description: | + Campo livre para preenchimento das informações adicionais referente ao campo network. + + [Restrição] Obrigatório quando "network” for igual “OUTROS“. + example: 'Informações adicionais' + CreditCardRewardsProgram: + type: object + required: + - hasRewardProgram + properties: + hasRewardProgram: + type: boolean + description: 'Indicador da existência de programa de fidelidade/recompensa associado à conta de pagamento pós-paga (cartão) true false' + example: false + rewardProgramInfo: + type: string + maxLength: 2000 + pattern: '[\w\W\s]*' + description: 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. Será de preenchimento obrigatório caso o campo hasRewardProgram esteja preenchido como true + example: 'https://empresaa1.com/credit_cards_rewards' + CreditCardTermsConditions: + type: object + required: + - minimumFeeRate + - elegibilityCriteriaInfo + - closingProcessInfo + properties: + minimumFeeRate: + type: string + pattern: '^\d{1}\.\d{6}$' + description: Percentual para pagamento mínimo sobre o saldo devedor da fatura. + example: '0.250000' + minLength: 8 + maxLength: 8 + additionalInfo: + type: string + maxLength: 500 + pattern: '[\w\W\s]*' + description: Campo aberto para detalhamento de taxas de juros + example: 'NA' + elegibilityCriteriaInfo: + type: string + maxLength: 2000 + pattern: '[\w\W\s]*' + description: '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.' + example: 'https://empresaa1.com/creditcards_elegibility_criteria' + closingProcessInfo: + type: string + maxLength: 2000 + pattern: '[\w\W\s]*' + description: 'Descrição dos procedimentos para encerramento da conta de pagamento pós paga. Pode ser informada a URL referente ao endereço onde constam as condições informadas.' + example: 'https://empresaa1.com/creditcards_closing_process' + CreditCardInterest: + type: object + description: Informações sobre taxas de juros + required: + - rates + - instalmentRates + - otherCredits + properties: + rates: + type: array + items: + $ref: '#/components/schemas/InterestRate' + minItems: 1 + maxItems: 20 + description: Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para crédito rotativo + instalmentRates: + type: array + items: + $ref: '#/components/schemas/InterestRate' + minItems: 1 + maxItems: 20 + description: Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para parcelamento do saldo devedor + otherCredits: + type: array + description: Lista de outras operações de crédito + items: + $ref: "#/components/schemas/CreditCardInterestRate" + minItems: 1 + maxItems: 3 + CreditCardInterestRate: + type: object + required: + - code + - additionalInfo + properties: + code: + type: string + enum: + - SAQUE_A_CREDITO + - PAGAMENTOS_CONTAS + - OUTROS + description: Lista de outras operações de crédito + example: SAQUE_A_CREDITO + codeAdditionalInfo: + type: string + maxLength: 140 + pattern: '[\w\W\s]*' + description: | + Campo livre para preenchimento das informações adicionais referente ao campo code. + + [Restrição] Obrigatório quando "code ” for igual “OUTROS“. + example: 'Informações adicionais' + PersonalCreditCardResponse: + type: object + required: + - data + - links + - meta + properties: + data: + type: object + required: + - brand + properties: + brand: + $ref: '#/components/schemas/PersonalCreditCardBrand' + links: + $ref: '#/components/schemas/Links' + meta: + $ref: '#/components/schemas/Meta' + PersonalCreditCardBrand: + type: object + required: + - name + - companies + properties: + name: + type: string + maxLength: 80 + pattern: '[\w\W\s]*' + description: Nome da Marca selecionada pelas Organizações + example: Organização A + companies: + type: array + description: Companies traz uma lista de todas as instituições da Marca + items: + $ref: '#/components/schemas/PersonalCreditCardCompany' + minItems: 1 + maxItems: 800 + PersonalCreditCardCompany: + type: object + required: + - name + - cnpjNumber + - personalCreditCards + properties: + name: + type: string + description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' + maxLength: 80 + pattern: '[\w\W\s]*' + example: 'Empresa A1' + cnpjNumber: + type: string + pattern: '^(\d{14})$|^NA$' + description: CNPJ + maxLength: 14 + example: "50685362000135" + urlComplementaryList: + type: string + pattern: '[\w\W\s]*' + maxLength: 1024 + description: | + URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. + Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada + example: 'https://empresadaorganizacaoa.com/complementarylist' + personalCreditCards: + type: array + description: Lista das contas de pagamento pós-paga + items: + $ref: '#/components/schemas/PersonalCreditCard' + minItems: 1 + maxItems: 300 + BusinessCreditCardResponse: + type: object + required: + - data + - links + - meta + properties: + data: + type: object + required: + - brand + properties: + brand: + $ref: '#/components/schemas/BusinessCreditCardBrand' + links: + $ref: '#/components/schemas/Links' + meta: + $ref: '#/components/schemas/Meta' + BusinessCreditCardBrand: + type: object + required: + - companies + properties: + name: + type: string + maxLength: 80 + pattern: '[\w\W\s]*' + description: Nome da Marca selecionada pelas Organizações + example: Organização A + companies: + type: array + description: Companies traz uma lista de todas as instituições da Marca + items: + $ref: '#/components/schemas/BusinessCreditCardCompany' + minItems: 1 + maxItems: 720 + BusinessCreditCardCompany: + type: object + required: + - name + - cnpjNumber + properties: + name: + type: string + description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' + maxLength: 80 + pattern: '[\w\W\s]*' + example: 'Empresa A1' + cnpjNumber: + type: string + pattern: '^(\d{14})$|^NA$' + description: CNPJ + maxLength: 14 + example: "50685362000135" + urlComplementaryList: + type: string + pattern: '[\w\W\s]*' + maxLength: 1024 + description: | + URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. + Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada + example: 'https://empresadaorganizacaoa.com/complementarylist' + businessCreditCards: + type: array + description: Lista dos nomes de conta de pagamento pós-paga + items: + $ref: '#/components/schemas/BusinessCreditCard' + minItems: 1 + maxItems: 80 + CreditCardService: + type: object + required: + - name + - code + - chargingTriggerInfo + - prices + - minimum + - maximum + properties: + name: + type: string + enum: + - ANUIDADE_CARTAO_BASICO_NACIONAL + - ANUIDADE_CARTAO_BASICO_INTERNACIONAL + - ANUIDADE_DIFERENCIADA + - UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_BRASIL + - UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_EXTERIOR + - AVALIACAO_EMERGENCIAL_CREDITO + - FORNECIMENTO_SEGUNDA_VIA_FUNCAO_CREDITO + - PAGAMENTO_CONTAS_UTILIZANDO_FUNCAO_CREDITO + - SMS + description: 'Denominação de Serviços relacionados à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM)' + example: ANUIDADE_CARTAO_BASICO_NACIONAL + code: + type: string + enum: + - ANUIDADE_NACIONAL + - ANUIDADE_INTERNACIONAL + - ANUIDADE_DIFERENCIADA + - SAQUE_CARTAO_BRASIL + - SAQUE_CARTAO_EXTERIOR + - AVALIACAO_EMERGENCIAL_CREDITO + - EMISSAO_SEGUNDA_VIA + - TARIFA_PAGAMENTO_CONTAS + - SMS + description: 'Sigla de identificação do Serviço relacionado à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM)' + example: ANUIDADE_NACIONAL + chargingTriggerInfo: + type: string + maxLength: 2000 + pattern: '[\w\W\s]*' + description: 'Fatos geradores de cobrança que incidem sobre as Modalidades de Contas de Pagamento Pós-Pagas informada, para pessoa jurídica. (Campo Livre)' + example: '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: + type: array + description: Lista distribuição preços tarifas de serviços + items: + $ref: '#/components/schemas/Price' + minItems: 4 + maxItems: 4 + minimum: + $ref: '#/components/schemas/MinimumPrice' + maximum: + $ref: '#/components/schemas/MaximumPrice' + Price: + type: object + required: + - interval + - value + - currency + - customers + properties: + interval: + $ref: '#/components/schemas/PriceIntervals' + value: + type: string + pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' + maxLength: 12 + x-cds-type: AmountString + description: | + Valor da mediana de cada faixa relativa ao serviço ofertado, informado no período, conforme Res nº 32 BCB, 2020. p.ex. '45.00' (representa um valor monetário. p.ex: 1547368.92. Este valor, considerando que a moeda seja BRL, significa R$ 1.547.368,92. O único separador presente deve ser o '.' (ponto) para indicar a casa decimal. Não deve haver separador de milhar) + example: '2000.00' + currency: + $ref: '#/components/schemas/Currency' + customers: + $ref: '#/components/schemas/Customer' + MinimumPrice: + type: object + required: + - value + - currency + properties: + value: + type: string + pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' + maxLength: 12 + x-cds-type: AmountString + description: Valor mínimo apurado para a tarifa de serviços sobre a base de clientes no mês de referência + example: '1350.00' + currency: + $ref: "#/components/schemas/Currency" + MaximumPrice: + type: object + required: + - value + - currency + properties: + value: + type: string + pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' + maxLength: 12 + x-cds-type: AmountString + description: Valor máximo apurado para a tarifa de serviços sobre a base de clientes no mês de referência + example: '8800.00' + currency: + $ref: "#/components/schemas/Currency" + Customer: + type: object + required: + - rate + properties: + rate: + type: string + description: | + Percentual de clientes em cada faixa. + pattern: '^\d{1}\.\d{6}$' + example: '0.150000' + minLength: 8 + maxLength: 8 + Currency: + type: string + pattern: '^(\w{3}){1}$' + maxLength: 3 + x-cds-type: CurrencyString + description: 'Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217' + example: BRL + InterestRate: + type: object + required: + - referentialRateIndexer + - rate + - applications + - minimumRate + - maximumRate + properties: + referentialRateIndexer: + $ref: '#/components/schemas/ReferentialRateIndexer' + rate: + type: string + description: | + Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). 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%) + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 + example: '0.150000' + applications: + type: array + description: Lista distribuição percentuais relativos à taxa de juros remuneratórios + items: + $ref: "#/components/schemas/ApplicationRate" + minItems: 4 + maxItems: 4 + minimumRate: + type: string + pattern: '^\d{1}\.\d{6}$' + description: '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%)' + minLength: 8 + maxLength: 8 + example: '0.045600' + maximumRate: + type: string + pattern: '^\d{1}\.\d{6}$' + description: '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%)' + minLength: 8 + maxLength: 8 + example: '0.686500' + ReferentialRateIndexer: + type: string + description: | + Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040 + enum: + - SEM_INDEXADOR_TAXA + - PRE_FIXADO + - POS_FIXADO_TR_TBF + - POS_FIXADO_TJLP + - POS_FIXADO_LIBOR + - POS_FIXADO_TLP + - OUTRAS_TAXAS_POS_FIXADAS + - FLUTUANTES_CDI + - FLUTUANTES_SELIC + - OUTRAS_TAXAS_FLUTUANTES + - INDICES_PRECOS_IGPM + - INDICES_PRECOS_IPCA + - INDICES_PRECOS_IPCC + - OUTROS_INDICES_PRECO + - CREDITO_RURAL_TCR_PRE + - CREDITO_RURAL_TCR_POS + - CREDITO_RURAL_TRFC_PRE + - CREDITO_RURAL_TRFC_POS + - OUTROS_INDEXADORES + example: 'SEM_INDEXADOR_TAXA' + PersonalCreditCard: + type: object + required: + - name + - identification + - rewardsProgram + - fees + - interest + - termsConditions + properties: + name: + type: string + pattern: '[\w\W\s]*' + maxLength: 50 + description: Denominação/Identificação do nome da conta (cartão de crédito) + example: Cartão Universitário + identification: + $ref: '#/components/schemas/CreditCardIdentification' + rewardsProgram: + $ref: '#/components/schemas/CreditCardRewardsProgram' + fees: + type: object + description: Objeto que reúne informações de tarifas de serviços + required: + - services + properties: + services: + type: array + description: Lista das Tarifas cobradas sobre Serviço relacionadas a Modalidade de Pagamento Pós-Pagas + items: + $ref: '#/components/schemas/CreditCardService' + minItems: 1 + maxItems: 9 + interest: + $ref: '#/components/schemas/CreditCardInterest' + termsConditions: + $ref: '#/components/schemas/CreditCardTermsConditions' + BusinessCreditCard: + type: object + required: + - name + - identification + - rewardsProgram + - fees + - interest + - termsConditions + properties: + name: + type: string + pattern: '[\w\W\s]*' + maxLength: 50 + description: Denominação/Identificação do nome da conta (cartão de crédito) + example: Cartão Vantagens + identification: + $ref: '#/components/schemas/CreditCardIdentification' + rewardsProgram: + $ref: '#/components/schemas/CreditCardRewardsProgram' + fees: + type: object + description: Objeto que reúne informações de tarifas de serviços + required: + - services + properties: + services: + type: array + description: Lista das Tarifas cobradas sobre Serviço relacionadas a Modalidade de Pagamento Pós-Pagas + items: + $ref: '#/components/schemas/CreditCardService' + minItems: 1 + maxItems: 9 + interest: + $ref: '#/components/schemas/CreditCardInterest' + termsConditions: + $ref: '#/components/schemas/CreditCardTermsConditions' + Links: + type: object + properties: + self: + type: string + maxLength: 2000 + description: URL da página atualmente requisitada + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' + example: 'https://api.banco.com.br/open-banking/products-services/v1/resource' + first: + type: string + maxLength: 2000 + description: URL da primeira página de registros + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' + example: 'https://api.banco.com.br/open-banking/products-services/v1/resource' + prev: + type: string + maxLength: 2000 + description: URL da página anterior de registros + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' + next: + type: string + maxLength: 2000 + description: URL da próxima página de registros + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' + last: + type: string + maxLength: 2000 + description: URL da última página de registros + pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' + example: 'https://api.banco.com.br/open-banking/products-services/v1/resource' + Meta: + type: object + properties: + totalRecords: + type: integer + description: Total de registros encontrados + example: 1 + totalPages: + type: integer + description: Total de páginas para os registros encontrados + example: 1 + required: + - totalRecords + - totalPages + ResponseErrorMetaSingle: + type: object + required: + - errors + properties: + errors: + type: array + minItems: 1 + maxItems: 13 + items: + type: object + required: + - code + - title + - detail + properties: + code: + description: Código de erro específico do endpoint + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + title: + description: Título legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + detail: + description: Descrição legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 2048 + meta: + type: object + description: Meta informações referente à API requisitada. + required: + - requestDateTime + properties: + requestDateTime: + description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.' + type: string + maxLength: 20 + format: date-time + example: '2021-05-21T08:30:00Z' + ResponseError: + type: object + required: + - errors + properties: + errors: + type: array + minItems: 1 + maxItems: 13 + items: + type: object + required: + - code + - title + - detail + properties: + code: + description: Código de erro específico do endpoint + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + title: + description: Título legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 255 + detail: + description: Descrição legível por humanos deste erro específico + type: string + pattern: '[\w\W\s]*' + maxLength: 2048 + meta: + type: object + description: Meta informações referente à API requisitada. + required: + - totalRecords + - totalPages + - requestDateTime + properties: + totalRecords: + type: integer + format: int32 + description: Número total de registros no resultado + example: 1 + totalPages: + type: integer + format: int32 + description: Número total de páginas no resultado + example: 1 + securitySchemes: + APIKey1: + name: API Key + type: apiKey + in: query + APIKey2: + name: API Key + type: apiKey + in: query + parameters: + page: + name: page + in: query + description: Número da página que está sendo requisitada (o valor da primeira página é 1). + schema: + type: integer + format: int32 + default: 1 + minimum: 1 + maximum: 2147483647 + pageSize: + name: page-size + in: query + description: Quantidade total de registros por páginas. + schema: + type: integer + format: int32 + default: 25 + minimum: 1 + maximum: 1000 + responses: + BadRequest: + description: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + NotFound: + description: O recurso solicitado não existe ou não foi implementado. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + MethodNotAllowed: + description: O consumidor tentou acessar o recurso com um método não suportado. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + TooManyRequests: + description: 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. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + InternalServerError: + description: Ocorreu um erro no gateway da API ou no microsserviço. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + GatewayTimeout: + description: GATEWAY TIMEOUT - A requisição não foi atendida dentro do tempo limite estabelecido. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + SiteIsOverloaded: + description: O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento. + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseErrorMetaSingle' + Default: + description: '\-' + content: + application/json; charset=utf-8: + schema: + $ref: '#/components/schemas/ResponseError' + \ No newline at end of file diff --git a/swagger-apis/opendata-creditcards/index.html b/swagger-apis/opendata-creditcards/index.html new file mode 100644 index 000000000..2bd64747c --- /dev/null +++ b/swagger-apis/opendata-creditcards/index.html @@ -0,0 +1,81 @@ + + + + + + Open Finance Brasil - OpenApi Specification + + + + + + + +
+

+ Essa é uma versão de rascunho e não deve ser utilizada para outras finalidades, você pode encontrar a documentação oficial e atualizada aqui +

+
+ +
+ + + + + + From f292026b1ddecaca43327b6bf34b029980626b66 Mon Sep 17 00:00:00 2001 From: FelipeBaumgartel Date: Wed, 9 Aug 2023 10:36:39 -0300 Subject: [PATCH 2/2] feat(Opendata Credit Cards): ORB-3216 - PC146 - opendata-creditcards - Criar API --- index.html | 1 + 1 file changed, 1 insertion(+) diff --git a/index.html b/index.html index 4e0906ecc..315048cc6 100644 --- a/index.html +++ b/index.html @@ -66,6 +66,7 @@ 'investments', 'invoice-financings', 'loans', + 'opendata-creditcards', 'participants', 'payments', 'pension',