diff --git a/dictionary/accountsGetAccountsAccountIdTransactions_v2.5.0.csv b/dictionary/accountsGetAccountsAccountIdTransactions_v2.5.0.csv new file mode 100644 index 00000000..8a6e4ef2 --- /dev/null +++ b/dictionary/accountsGetAccountsAccountIdTransactions_v2.5.0.csv @@ -0,0 +1,81 @@ +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 dos lançamentos referentes às transações realizadas e de lançamentos futuros para as contas de: depósito à vista, poupança e de pagamento pré-paga +";Lista;;Obrigatório;;;0;N;"";Não permitido;array;; +/data/transactionId;transactionId;"Código ou identificador único prestado pela instituição que mantém a conta para representar a transação individual. +O ideal é que o `transactionId` seja imutável. +No entanto, o `transactionId` deve obedecer, no mínimo, as regras de imutabilidade propostas conforme tabela “Data de imutabilidade por tipo de transação” presente nas orientações desta API. +";Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl;1 +/data/completedAuthorisedPaymentType;completedAuthorisedPaymentType;"Indicador da transação: + - Transação efetivada: a transação atinge esse status quando o `transactionId` torna-se imutável; + - Lançamento futuro: a transação será efetivada em momento futuro, ou seja, o `transactionId` pode mudar; + - Transação processando: a transação está em processamento, ou seja, o `transactionId` pode mudar. +";Texto;;Obrigatório;;"TRANSACAO_EFETIVADA +LANCAMENTO_FUTURO +TRANSACAO_PROCESSANDO";1;1;"";Não permitido;string;TRANSACAO_EFETIVADA; +/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/transactionName;transactionName;"Literal usada na instituição financeira para identificar a transação. +A informação apresentada precisa ser a mesma utilizada nos canais digitais da instituição (assim como o histórico de transações apresentado na tela do aplicativo ou do navegador). +Caso a instituição possua mais de um canal digital, a informação compartilhada deve ser a do canal que apresenta a descrição mais completa possível da transação. +Em casos onde a descrição da transação é apresentada com múltiplas linhas, todas as linhas devem ser enviadas (concatenadas) neste atributo, não sendo obrigatória a concatenação das informações já enviadas em outros atributos (ex: valor, data) do mesmo endpoint. +Adicionalmente, o Banco Central pode determinar o formato de compartilhamento a ser adotado por uma instituição participante específica. +";Texto;200;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Transferencia Enviada Lima Santos; +/data/type;type;"O campo deve classificar a transação em um dos tipos descritos. +O transmissor deve classificar as transações disponíveis associando-a a um dos itens do Enum listado neste campo. +A opção OUTROS só deve ser utilizada para os casos em que de fato a transação compartilhada não possa ser classificada como um dos itens deste Enum. +Por exemplo no caso de recebimento de pensão alimentícia. +";Texto;;Obrigatório;;"TED +DOC +PIX +TRANSFERENCIA_MESMA_INSTITUICAO +BOLETO +CONVENIO_ARRECADACAO +PACOTE_TARIFA_SERVICOS +TARIFA_SERVICOS_AVULSOS +FOLHA_PAGAMENTO +DEPOSITO +SAQUE +CARTAO +ENCARGOS_JUROS_CHEQUE_ESPECIAL +RENDIMENTO_APLIC_FINANCEIRA +PORTABILIDADE_SALARIO +RESGATE_APLIC_FINANCEIRA +OPERACAO_CREDITO +TRANSFERENCIA_SALDO_RESERVADO +OUTROS";1;1;"";Não permitido;string;PIX; +/data/typeAdditionalInfo;typeAdditionalInfo;"Informações complementares para tipo de transação. + +[Restrição] Este campo é de envio obrigatório caso o campo `type` seja definido como `OUTROS`. +";Texto;;Condicional;[\w\W\s]*;;0;1;" Este campo é de envio obrigatório caso o campo `type` seja definido como `OUTROS`. +";Não permitido;string;APLIC_FINANCEIRA; +/data/transactionAmount;transactionAmount;Valor da transação. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; +/data/transactionAmount/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/transactionAmount/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/transactionDateTime;transactionDateTime;"Data e hora original da transação que é informada nos canais digitais. Para lançamentos Futuros a data informada deve ser a data prevista de efetivação informada nos canais digitais. Caso a instituição não saiba o horário certo da efetivação, os valores hora, minuto, segundo e milissegundo, podem ser preenchidos com zero. Após a efetivação da transação, o campo deve ser preenchido com a data e a hora da efetivação da transação. +";Texto;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/partieCnpjCpf;partieCnpjCpf;"Identificação da pessoa envolvida na transação: pagador ou recebedor (Preencher com o CPF ou CNPJ, sem formatação). Com a IN BCB nº 371, a partir de 02/05/23, o envio das informações de identificação de contraparte tornou-se obrigatória para transações de pagamento. Para maiores detalhes, favor consultar a página `Orientações - Contas`. + +[Restrição] Quando o ""type“ for preenchido com valor FOLHA_PAGAMENTO e a transmissora for a responsável pelo pagamento de salário (banco-folha), o partieCnpjCpf informado deve ser do empregador relacionado. +";Texto;14;Condicional;^([0-9]{11}|[0-9A-Z]{12}[0-9]{2})$;;0;1;" Quando o ""type“ for preenchido com valor FOLHA_PAGAMENTO e a transmissora for a responsável pelo pagamento de salário (banco-folha), o partieCnpjCpf informado deve ser do empregador relacionado. +";Não permitido;string;43908445778; +/data/partiePersonType;partiePersonType;"Identificação do Tipo de Pessoa da pessoa envolvida na transação. +Pessoa Natural - Informar CPF no campo “partieCnpjCpf”. +Pessoa Jurídica - Informar CNPJ no campo “partieCnpjCpf”. +";Texto;;Opcional;;"PESSOA_NATURAL +PESSOA_JURIDICA";0;1;"";Não permitido;string;PESSOA_NATURAL; +/data/partieCompeCode;partieCompeCode;"Código identificador atribuído pelo Banco Central do Brasil às instituições participantes do STR (Sistema de Transferência de reservas) referente à pessoa envolvida na transação. O número-código substituiu o antigo código COMPE. Todos os participantes do STR, exceto as Infraestruturas do Mercado Financeiro (IMF) e a Secretaria do Tesouro Nacional, possuem um número-código independentemente de participarem da Centralizadora da Compensação de Cheques (Compe). + +[RESTRIÇÃO] É de preenchimento obrigatório quando a instituição possuir o número-código. +";Texto;3;Opcional;^\d{3}$;;0;1;"";Não permitido;string;001; +/data/partieBranchCode;partieBranchCode;Código da Agência detentora da conta da pessoa envolvida na transação. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória);Texto;4;Opcional;^\d{4}$;;0;1;"";Não permitido;string;6272; +/data/partieNumber;partieNumber;Número da conta da pessoa envolvida na transação;Texto;20;Opcional;^\d{8,20}$;;0;1;"";Não permitido;string;67890854360; +/data/partieCheckDigit;partieCheckDigit;Dígito da conta da pessoa envolvida na transação;Texto;1;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;4; +/data/codeISPB;codeISPB;"Código único atribuído pelo Banco Central do Brasil a cada instituição participante do Sistema de Pagamentos. + +Este campo identifica o ISPB da instituição contraparte da transação e deve ser preenchido de acordo com o atributo que indica o sentido financeiro da transação, de acordo com o campo `creditDebitType`: +- Para transações de CREDITO (entrada de recursos na conta): informar o ISPB da instituição de origem dos recursos. +- Para transações de DEBITO (saída de recursos na conta): informar o ISPB da instituição de destino dos recursos. [RESTRIÇÃO] É de preenchimento obrigatório quando existir informação de contraparte. +";Texto;;Opcional;^[0-9A-Z]{8}$;;0;1;"";Não permitido;string;00300300; diff --git a/dictionary/accountsGetAccounts_v2.5.0.csv b/dictionary/accountsGetAccounts_v2.5.0.csv new file mode 100644 index 00000000..4b0dde1f --- /dev/null +++ b/dictionary/accountsGetAccounts_v2.5.0.csv @@ -0,0 +1,24 @@ +Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo +/data;data;Lista de contas depósito à vista, poupança e pagamento pré-pagas mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento;Lista;;Obrigatório;;;0;N;"";Não permitido;array;; +/data/brandName;brandName;Nome da Marca reportada pelo participante no Open Finance. Recomenda-se utilizar, sempre que possível, o mesmo nome de marca atribuído no campo do diretório Customer Friendly Server Name (Authorisation Server).;Texto;80;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;Organização A; +/data/companyCnpj;companyCnpj;Registro completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde a representação alfanumérica da inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os caracteres do CNPJ, sem máscara.;Texto;14;Obrigatório;^[0-9A-Z]{12}[0-9]{2}$;;1;1;"";Não permitido;string;21128159000166; +/data/type;type;"Tipos de contas. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Vide Enum +Conta de depósito à vista ou Conta corrente - é o tipo mais comum. Nela, o dinheiro fica à sua disposição para ser sacado a qualquer momento. Essa conta não gera rendimentos para o depositante +Conta poupança - foi criada para estimular as pessoas a pouparem. O dinheiro que ficar na conta por trinta dias passa a gerar rendimentos, com isenção de imposto de renda para quem declara. Ou seja, o dinheiro “cresce” (rende) enquanto ficar guardado na conta. Cada depósito terá rendimentos de mês em mês, sempre no dia do mês em que o dinheiro tiver sido depositado +Conta de pagamento pré-paga: segundo CIRCULAR Nº 3.680, BCB de 2013, é a 'destinada à execução de transações de pagamento em moeda eletrônica realizadas com base em fundos denominados em reais previamente aportados' +";Texto;;Obrigatório;;"CONTA_DEPOSITO_A_VISTA +CONTA_POUPANCA +CONTA_PAGAMENTO_PRE_PAGA";1;1;"";Não permitido;string;CONTA_DEPOSITO_A_VISTA; +/data/compeCode;compeCode;Código identificador atribuído pelo Banco Central do Brasil às instituições participantes do STR (Sistema de Transferência de reservas).O Compe (Sistema de Compensação de Cheques e Outros Papéis) é um sistema que identifica e processa as compensações bancárias. Ele é representado por um código de três dígitos que serve como identificador de bancos, sendo assim, cada instituição bancária possui um número exclusivo;Texto;3;Obrigatório;^\d{3}$;;1;1;"";Não permitido;string;001; +/data/branchCode;branchCode;"Código da Agência detentora da conta. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória) + +[Restrição] Obrigatoriamente deve ser preenchido quando o campo ""type"" for diferente de CONTA_PAGAMENTO_PRE_PAGA. +";Texto;4;Condicional;^\d{4}$;;0;1;" Obrigatoriamente deve ser preenchido quando o campo ""type"" for diferente de CONTA_PAGAMENTO_PRE_PAGA. +";Não permitido;string;6272; +/data/number;number;Número da conta;Texto;20;Obrigatório;^\d{8,20}$;;1;1;"";Não permitido;string;94088392; +/data/checkDigit;checkDigit;"Dígito da conta + +[Restrição] Obrigatoriamente deve ser preenchido quando o campo `type` for diferente de conta pré-paga. Nos casos em que a conta pré-paga possua dígito, o envio é obrigatório. +";Texto;1;Condicional;[\w\W\s]*;;0;1;" Obrigatoriamente deve ser preenchido quando o campo `type` for diferente de conta pré-paga. Nos casos em que a conta pré-paga possua dígito, o envio é obrigatório. +";Não permitido;string;4; +/data/accountId;accountId;Identifica de forma única a conta do cliente, mantendo as regras de imutabilidade dentro da instituição transmissora.;Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;92792126019929279212650822221989319252576;1 \ No newline at end of file