Skip to content

Commit

Permalink
Merge branch 'release-credit-cards-2023-08-29' into draft-release-cre…
Browse files Browse the repository at this point in the history
…dit-cards-2023-08-29
  • Loading branch information
andretrindade committed Aug 29, 2023
2 parents 3cce877 + d40cd97 commit faf27fb
Show file tree
Hide file tree
Showing 9 changed files with 2,549 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
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/transactionId;transactionId;"Código ou identificador único prestado pela instituição que mantém a conta para representar a transação individual.
É esperado que o `transactionId` seja único, imutável e estável.
";Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl;1
/data/identificationNumber;identificationNumber;"Número de identificação do cartão: corresponde aos 4 últimos dígitos do cartão para PF, ou então, preencher com um identificador para PJ, com as caracteristicas definidas para os IDs no Open Finance.
";Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;4453;1
/data/transactionName;transactionName;Literal usada na instituição financeira para identificar a transação. A informação apresentada precisa ser a mesma utilizada nos canais eletrônicos da instituição (extrato e fatura).;Texto;200;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;PGTO;
/data/billId;billId;Informação que identifica a fatura onde consta a transação informada.;Texto;100;Opcional;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;0;1;"";Não permitido;string;MTU0OTU1NjI2NTk4OTRmc2ZhZDRmc2Q1NmZkM;1
/data/creditDebitType;creditDebitType;"Indicador do tipo de lançamento:
Débito (no extrato) Em um extrato bancário, os débitos, marcados com a letra “D” ao lado do valor registrado, informam as saídas de dinheiro na conta-corrente.
Crédito (no extrato) Em um extrato bancário, os créditos, marcados com a letra “C” ao lado do valor registrado, informam as entradas de dinheiro na conta-corrente.
";Texto;;Obrigatório;;"CREDITO
DEBITO";1;1;"";Não permitido;string;DEBITO;
/data/transactionType;transactionType;Traz os tipos de Transação;Texto;;Obrigatório;;"PAGAMENTO
TARIFA
OPERACOES_CREDITO_CONTRATADAS_CARTAO
ESTORNO
CASHBACK
OUTROS";1;1;"";Não permitido;string;CASHBACK;
/data/transactionalAdditionalInfo;transactionalAdditionalInfo;"Campo livre, de preenchimento obrigatório quando selecionado tipo de transação ""OUTROS""";Texto;140;Opcional;^\S[\s\S]*$;;0;1;"";Não permitido;string;;
/data/paymentType;paymentType;"Traz os tipos de pagamento.

[Restrição] Preenchimento obrigatório se Tipo de Transação selecionada for 'PAGAMENTO'.
";Texto;;Condicional;;"A_VISTA
A_PRAZO";0;1;" Preenchimento obrigatório se Tipo de Transação selecionada for 'PAGAMENTO'.
";Não permitido;string;A_VISTA;
/data/feeType;feeType;"Traz os tipos de Tarifas: (Vide Enum) Anuidade, Saque com cartão no Brasil, Saque com cartão no exterior, Avaliação emergencial de crédito, Emissão segunda via, Tarifa pagamento de contas, SMS, OUTRA.

[Restrição] Preenchimento obrigatório se Tipo de Transação selecionada for 'TARIFA'.
";Texto;;Condicional;;"ANUIDADE
SAQUE_CARTAO_BRASIL
SAQUE_CARTAO_EXTERIOR
AVALIACAO_EMERGENCIAL_CREDITO
EMISSAO_SEGUNDA_VIA
TARIFA_PAGAMENTO_CONTAS
SMS
OUTRA";0;1;" Preenchimento obrigatório se Tipo de Transação selecionada for 'TARIFA'.
";Não permitido;string;ANUIDADE;
/data/feeTypeAdditionalInfo;feeTypeAdditionalInfo;"Campo livre, de preenchimento obrigatório quando selecionada tipo de tarifa ""OUTRA""";Texto;140;Opcional;^\S[\s\S]*$;;0;1;"";Não permitido;string;;
/data/otherCreditsType;otherCreditsType;"Traz outros tipos de crédito contratados no cartão.

[Restrição] Preenchimento obrigatório se o tipo transação selecionado for 'OPERACOES_CREDITO_CONTRATADAS_CARTAO'.
";Texto;;Condicional;;"CREDITO_ROTATIVO
PARCELAMENTO_FATURA
EMPRESTIMO
OUTROS";0;1;" Preenchimento obrigatório se o tipo transação selecionado for 'OPERACOES_CREDITO_CONTRATADAS_CARTAO'.
";Não permitido;string;CREDITO_ROTATIVO;
/data/otherCreditsAdditionalInfo;otherCreditsAdditionalInfo;"Campo livre para preenchimento de dados adicionais de outros tipos de crédito contratados no cartão.

[Restrição] Preenchimento obrigatório quando selecionado no campo outros tipos de crédito ""OUTROS"".
";Texto;50;Condicional;^\S[\s\S]*$;;0;1;" Preenchimento obrigatório quando selecionado no campo outros tipos de crédito ""OUTROS"".
";Não permitido;string;;
/data/chargeIdentificator;chargeIdentificator;"Número da parcela que está sendo informada.

[Restrição] Preenchimento obrigatório se Tipo de Pagamento (paymentType) selecionada for 'A_PRAZO'.
";Número;;Condicional;;;0;1;" Preenchimento obrigatório se Tipo de Pagamento (paymentType) selecionada for 'A_PRAZO'.
";Não permitido;number;12;
/data/chargeNumber;chargeNumber;"Quantidade de parcelas.
[Restrição] O campo deve ser preenchido quando houverem parcelas relacionadas a transação.
";Número;;Condicional;;;0;1;" O campo deve ser preenchido quando houverem parcelas relacionadas a transação.
";Não permitido;number;12;
/data/brazilianAmount;brazilianAmount;"Valor da transação expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais, em moeda corrente do Brasil. Deve ser o valor de amount convertido para BRL (em caso de compra internacional) ou o mesmo valor de amount (em caso de compra nacional).
";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/brazilianAmount/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/brazilianAmount/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/amount;amount;"Valor original da transação. Expresso em valor monetário com no mínimo 2 casas decimais e no máximo 4 casas decimais. Deve ser sempre preenchido com o valor original da transação independente da nacionalidade, sem convertê-lo.
";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/amount/amount;amount;Valor relacionado ao objeto.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/amount/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/transactionDate;transactionDate;Data original da transação;Data;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-05-21;
/data/transactionDateTime;transactionDateTime;"Data e hora original da transação.
No primeiro momento, as instituições poderão complementar informações faltantes com 0 (Por exemplo: 2016-01-29T00:00:00.000Z)
A partir de 31/01/2024 é esperado que o campo seja preenchido com informações reais.
";Date Hora;24;Obrigatório;(^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)\.(?:[0-9]){3}Z$);;1;1;"";Não permitido;string;2016-01-29T12:29:03.374Z;
/data/billPostDate;billPostDate;Data em que a transação foi inserida na fatura;Data;20;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-05-21;
/data/payeeMCC;payeeMCC;"O MCC ou o código da categoria do estabelecimento comercial. Os MCCs são agrupados segundo suas similaridades. O MCC é usado para classificar o negócio pelo tipo fornecido de bens ou serviços. Os MCCs são atribuídos por tipo de comerciante (por exemplo, um para hotéis, um para lojas de materiais de escritório, etc.) ou por nome de comerciante (por exemplo, 3000 para a United Airlines).
";Número;;Opcional;;;0;1;"";Não permitido;number;5137;
62 changes: 62 additions & 0 deletions dictionary/creditCardsGetAccountsCreditCardAccountIdBills_v3.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
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/billId;billId;Informação que identifica a fatura;Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;3459087XXZTR;1
/data/dueDate;dueDate;Data de vencimento da Fatura, que aparece para pagamento pelo cliente;Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-05-21;
/data/billTotalAmount;billTotalAmount;"Valor total da faturas.
O campo deve assumir valor positivo para saldo devedor e negativo para saldo credor.
";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/billTotalAmount/amount;amount;Valor total da faturas. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/billTotalAmount/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/billMinimumAmount;billMinimumAmount;"Valor do pagamento minimo da fatura
";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/billMinimumAmount/amount;amount;Valor do pagamento minimo da fatura;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/billMinimumAmount/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/isInstalment;isInstalment;Indica se a fatura permite parcelamento (true) ou não (false).;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;false;
/data/financeCharges;financeCharges;Lista dos encargos cobrados na fatura;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/financeCharges/type;type;"Traz a denominação dos Encargos que
incidem na fatura da conta de pagamento pós-paga. (Vide Enum)
- Juros remuneratórios por atraso no pagamento da fatura
- Multa por atraso no pagamento da fatura
- Juros de mora por atraso no pagamento da fatura
- IOF
- Outros
";Texto;;Obrigatório;;"JUROS_REMUNERATORIOS_ATRASO_PAGAMENTO_FATURA
MULTA_ATRASO_PAGAMENTO_FATURA
JUROS_MORA_ATRASO_PAGAMENTO_FATURA
IOF
OUTROS";1;1;"";Não permitido;string;;
/data/financeCharges/additionalInfo;additionalInfo;Campo livre, de preenchimento obrigatório se selecionado tipo de encargo 'OUTROS';Texto;140;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Informações Adicionais;
/data/financeCharges/amount;amount;Valor cobrado pelo encargo. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;100000.0400;4
/data/financeCharges/currency;currency;"Moeda referente ao valor cobrado pelo encargo, segundo modelo ISO-4217. p.ex. 'BRL'
Todos os saldos informados estão representados com a moeda vigente do Brasil.
";Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
/data/payments;payments;Lista que traz os valores relativos aos pagamentos da Fatura da conta de pagamento pós-paga;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
/data/payments/valueType;valueType;"Traz os tipos dos valores relativos aos pagamentos da fatura da conta de pagamento pós-paga: (Vide Enum)
- Valor de pagamento da fatura com parcelamento
- Valor pagamento da fatura realizado
- Outro Valor pago na fatura

VALOR_PAGAMENTO_FATURA_PARCELADO: Quando o pagamento corresponde ao fato gerador para abertura do plano de parcelamento da fatura

VALOR_PAGAMENTO_FATURA_REALIZADO: Quando o pagamento corresponde ao valor total da fatura

OUTRO_VALOR_PAGO_FATURA: Demais casos
";Texto;;Obrigatório;;"VALOR_PAGAMENTO_FATURA_PARCELADO
VALOR_PAGAMENTO_FATURA_REALIZADO
OUTRO_VALOR_PAGO_FATURA";1;1;"";Não permitido;string;;
/data/payments/paymentDate;paymentDate;Data efetiva de quando o Pagamento da fatura foi realizado;Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-05-21;
/data/payments/paymentMode;paymentMode;"Traz as formas de efetivação do pagamento realizado: (Vide Enum)
- Débito em conta corrente
- Boleto bancário
- Averbação em folha
- PIX
";Texto;;Obrigatório;;"DEBITO_CONTA_CORRENTE
BOLETO_BANCARIO
AVERBACAO_FOLHA
PIX";1;1;"";Não permitido;string;;
/data/payments/amount;amount;"Valor pagamento segundo o valueType.
Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
O campo não pode assumir valor negativo por se tratar de um pagamento.
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/payments/currency;currency;"Moeda referente ao valor de pagamento da fatura, segundo modelo ISO-4217. p.ex. 'BRL' Todos os valores informados estão representados com a moeda vigente do Brasil
";Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
78 changes: 78 additions & 0 deletions dictionary/creditCardsGetAccountsCreditCardAccountIdLimits_v3.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
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;"[Restrição] A lista vazia deve ser interpretada como a ausência da informação.

Cenário de limite com valor zerado, deve ter um registro explícito informando o valor como zero.

Cenário de ""cartão sem limite"", isto é, cartões em que o uso do limite é ilimitado, deve ser informado em um registro explícito com isLimitFlexible como true.
";Lista;;Obrigatório;;;0;N;" A lista vazia deve ser interpretada como a ausência da informação.

Cenário de limite com valor zerado, deve ter um registro explícito informando o valor como zero.

Cenário de ""cartão sem limite"", isto é, cartões em que o uso do limite é ilimitado, deve ser informado em um registro explícito com isLimitFlexible como true.
";Não permitido;array;;
/data/creditLineLimitType;creditLineLimitType;"Indicador do tipo de limite

LIMITE_CREDITO_TOTAL: Limite de crédito total aplicado a conta cartão.

LIMITE_CREDITO_MODALIDADE_OPERACAO: Limite de crédito por modalidade desse conta cartão (observar lineName e listar os aplicáveis da instituição).
";Texto;;Obrigatório;;"LIMITE_CREDITO_TOTAL
LIMITE_CREDITO_MODALIDADE_OPERACAO";1;1;"";Não permitido;string;LIMITE_CREDITO_TOTAL;
/data/consolidationType;consolidationType;"Indicador que permite informar se o valor do limite é consolidado ou individual.

CONSOLIDADO: utilizado quando o limite da conta cartão é compartilhado entre todos os métodos de pagamento (paymentMethod) atrelados a conta.

INDIVIDUAL: Utilizado quando cada método de pagamento (paymentMethod) possui seu limite segregado.
";Texto;;Obrigatório;;"CONSOLIDADO
INDIVIDUAL";1;1;"";Não permitido;string;CONSOLIDADO;
/data/identificationNumber;identificationNumber;"Número de identificação do cartão: corresponde aos 4 últimos dígitos do cartão para PF, ou então, preencher com um identificador para PJ, com as caracteristicas definidas para os IDs no Open Finance.
";Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;4453;1
/data/lineName;lineName;;Texto;;Opcional;;"CREDITO_A_VISTA
CREDITO_PARCELADO
SAQUE_CREDITO_BRASIL
SAQUE_CREDITO_EXTERIOR
EMPRESTIMO_CARTAO_CONSIGNADO
OUTROS";0;1;"";Não permitido;string;CREDITO_A_VISTA;
/data/lineNameAdditionalInfo;lineNameAdditionalInfo;Campo de preenchimento obrigatório se selecionada a opção 'OUTRAS' em lineName.;Texto;50;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Informações adicionais e complementares.;
/data/isLimitFlexible;isLimitFlexible;True= Indica que a conta cartão possui limite total flexível ou “sem limite”. False = Indica que a conta cartão possui limite predeterminado exibido no canal para o cliente.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
/data/limitAmount;limitAmount;"Valor total do limite concedido.
";Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/limitAmount/amount;amount;"Valor total do limite informado expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.

[Restrição] O campo é obrigatório caso isLimitFlexible for igual a false.
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;" O campo é obrigatório caso isLimitFlexible for igual a false.
";Não permitido;string;1000.0400;4
/data/limitAmount/currency;currency;"Moeda referente ao limite informado, segundo modelo ISO-4217. p.ex. 'BRL.'
Todos os limite informados estão representados com a moeda vigente do Brasil.

[Restrição] O campo é obrigatório caso isLimitFlexible for igual a false.
";Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;" O campo é obrigatório caso isLimitFlexible for igual a false.
";Não permitido;string;BRL;
/data/limitAmount/limitAmountReason;limitAmountReason;"Razão pela qual o valor total do limite informado está igual a zero.

[Restrição] Campo de preenchimento obrigatório quando limitAmount for igual a 0.00.
";Texto;200;Condicional;[\w\W\s]*;;0;1;" Campo de preenchimento obrigatório quando limitAmount for igual a 0.00.
";Não permitido;string;O perfil do cliente passou por uma análise e o limite precisou ser zerado;
/data/usedAmount;usedAmount;Valor utilizado do limite informado;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/usedAmount/amount;amount;Valor utilizado do limite informado expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/usedAmount/currency;currency;"Moeda referente ao limite informado, segundo modelo ISO-4217. p.ex. 'BRL.'
Todos os saldos informados estão representados com a moeda vigente do Brasil.
";Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
/data/availableAmount;availableAmount;"Valor disponível do limite informado
";Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/availableAmount/amount;amount;"Valor disponível do limite informado expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.

[Restrição] O campo é obrigatório caso isLimitFlexible for igual a false.
";Texto;21;Condicional;^-?\d{1,15}\.\d{2,4}$;;0;1;" O campo é obrigatório caso isLimitFlexible for igual a false.
";Não permitido;string;1000.0400;4
/data/availableAmount/currency;currency;"Moeda referente ao limite informado, segundo modelo ISO-4217. p.ex. 'BRL.'
Todos os saldos informados estão representados com a moeda vigente do Brasil.

[Restrição] O campo é obrigatório caso isLimitFlexible for igual a false.
";Texto;3;Condicional;^[A-Z]{3}$;;0;1;" O campo é obrigatório caso isLimitFlexible for igual a false.
";Não permitido;string;BRL;
/data/customizedLimitAmount;customizedLimitAmount;"Valor total do limite customizado pelo cliente nos canais eletrônicos da instituição. Esse objeto é de envio obrigatório nos casos em que a instituição permita ao cliente alterar o seu limite.
";Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/customizedLimitAmount/amount;amount;"Valor total do limite informado expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/customizedLimitAmount/currency;currency;"Moeda referente ao limite informado, segundo modelo ISO-4217. p.ex. 'BRL.' Todos os limite informados estão representados com a moeda vigente do Brasil.
";Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
Loading

0 comments on commit faf27fb

Please sign in to comment.