Skip to content

Commit 4ce1fb2

Browse files
author
Silvio
authored
Merge pull request #358 from Sensedia/release-loans-31102025
GT Dados do cliente: Feat(Loans) Versão 2.6.0-beta.1
2 parents 17ffab7 + 61af367 commit 4ce1fb2

7 files changed

+2159
-2
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
2+
/data;data;Conjunto de informações referentes aos pagamentos realizados de uma operação de crédito de empréstimos.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
3+
/data/paidInstalments;paidInstalments;Quantidade total de parcelas pagas do contrato referente à Modalidade de Crédito informada.;Número;2147483647;Opcional;;;0;1;"";Não permitido;number;73;
4+
/data/contractOutstandingBalance;contractOutstandingBalance;"Valor necessário para o cliente liquidar a dívida, ou seja, este campo deve ser preenchido com o saldo devedor atualizado descrito no DDC (Documento Descritivo de Crédito).
5+
O valor a liquidar atualizado do dia deve ser ajustado para compartilhamento pela Transmissora até às 10:00 do mesmo dia, especialmente para Crédito Pessoal Clean, escopo de Portabilidade de Crédito, pois este valor é utilizado pela Receptora em papel de Proponente para pagamento à Transmissora em papel de Credora.
6+
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
7+
/data/lastUpdatedContractOutstandingBalance;lastUpdatedContractOutstandingBalance;"Data e hora da última atualização do valor do campo contractOutstandingBalance, conforme especificação RFC-3339, formato UTC.
8+
9+
[Restrição] O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN na identificação da operação, no endpoint /contracts/{contractId}).
10+
";Date Hora;24;Condicional;;;0;1;" O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN na identificação da operação, no endpoint /contracts/{contractId}).
11+
";Não permitido;string;2021-05-21T08:30:03.374Z;24
12+
/data/totalRemainingAmount;totalRemainingAmount;"Valor total que falta para o cliente liquidar o contrato, considerando o somatório total de todas as parcelas a vencer e vencidas, bem como todas as taxas, tarifas e encargos das parcelas. Nos casos de contrato com taxas pós-fixadas, considerar apenas valores pré-fixados, visto que o cálculo pós-fixado ocorre apenas em momento futuro, e que o valor está sujeito às variações de seu indexador.
13+
14+
[Restrição] O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN na identificação da operação, no endpoint /contracts/{contractId}).
15+
";Texto;20;Condicional;^\d{1,15}\.\d{2,4}$;;0;1;" O envio do campo será obrigatório para CPC (campo “productSubTypeCategory” preenchido com CREDITO_PESSOAL_CLEAN na identificação da operação, no endpoint /contracts/{contractId}).
16+
";Não permitido;string;1000.0400;4
17+
/data/releases;releases;Lista dos pagamentos realizados no período;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
18+
/data/releases/paymentId;paymentId;Código ou identificador único prestado pela instituição para representar o pagamento individual.;Texto;100;Obrigatório;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;1;1;"";Não permitido;string;XlthLXpBLVowLTldW2EtekEtWjAtOVwtXXswLDk5fSQ;1
19+
/data/releases/isOverParcelPayment;isOverParcelPayment;Identifica se é um pagamento pactuado (false) ou avulso (true).;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
20+
/data/releases/instalmentId;instalmentId;"Identificador de parcela, de responsabilidade de cada Instituição transmissora.
21+
[Restrição] Informação de envio obrigatório quando isOverParcelPayment tiver o valor FALSE.
22+
";Texto;100;Condicional;^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$;;0;1;" Informação de envio obrigatório quando isOverParcelPayment tiver o valor FALSE.
23+
";Não permitido;string;WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH;1
24+
/data/releases/paidDate;paidDate;Data efetiva do pagamento referente ao contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19;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;
25+
/data/releases/currency;currency;"Moeda referente ao valor monetário informado, segundo modelo ISO-4217. p.ex. 'BRL'.
26+
Todos os valores monetários informados estão representados com a moeda vigente do Brasil.
27+
";Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
28+
/data/releases/paidAmount;paidAmount;"Valor do pagamento referente ao contrato da modalidade de crédito consultada. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais. Se encargos e taxas foram pagos juntos da parcela, a soma total deve ser adicionada ao valor da parcela neste campo. Caso o pagamento de taxas e encargos tenham sido feitos a parte, devem ser listados no campo ovelParcel.
29+
";Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
30+
/data/releases/overParcel;overParcel;"Objeto das tarifas e encargos que foram pagos fora da parcela.
31+
32+
[Restrição] Informação deve ser enviada caso ela exista.
33+
";Objeto;;Condicional;;;0;1;" Informação deve ser enviada caso ela exista.
34+
";Não permitido;object;;
35+
/data/releases/overParcel/fees;fees;Lista das tarifas que foram pagas fora da parcela, só para pagamento avulso.;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
36+
/data/releases/overParcel/fees/feeName;feeName;"Denominação da Tarifa pactuada.
37+
";Texto;140;Obrigatório;^[^\s](.*[^\s])?$;;1;1;"";Não permitido;string;Reavaliação periódica do bem;
38+
/data/releases/overParcel/fees/feeCode;feeCode;"Sigla identificadora da tarifa pactuada.
39+
";Texto;140;Obrigatório;^[^\s](.*[^\s])?$;;1;1;"";Não permitido;string;aval_bem;
40+
/data/releases/overParcel/fees/feeAmount;feeAmount;"Valor monetário da tarifa pactuada no contrato.
41+
42+
Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
43+
";Texto;21;Obrigatório;^-?\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;100000.0400;4
44+
/data/releases/overParcel/charges;charges;Lista dos encargos que foram pagos fora da parcela.;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
45+
/data/releases/overParcel/charges/chargeType;chargeType;Tipo de encargo pactuado no contrato.;Texto;;Obrigatório;;"JUROS_REMUNERATORIOS_POR_ATRASO
46+
MULTA_ATRASO_PAGAMENTO
47+
JUROS_MORA_ATRASO
48+
IOF_CONTRATACAO
49+
IOF_POR_ATRASO
50+
SEM_ENCARGO
51+
OUTROS";1;1;"";Não permitido;string;JUROS_REMUNERATORIOS_POR_ATRASO;
52+
/data/releases/overParcel/charges/chargeAdditionalInfo;chargeAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao encargo.
53+
54+
[Restrição] Obrigatório quando chargeType for igual 'OUTROS'.
55+
";Texto;140;Condicional;^[^\s](.*[^\s])?$;;0;1;" Obrigatório quando chargeType for igual 'OUTROS'.
56+
";Não permitido;string;Informações adicionais;
57+
/data/releases/overParcel/charges/chargeAmount;chargeAmount;Valor do pagamento do encargo pago fora da parcela. 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
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
2+
/data;data;Conjunto de informações referentes ao prazo remanescente e às parcelas de uma operação de crédito de empréstimos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
3+
/data/typeNumberOfInstalments;typeNumberOfInstalments;Tipo de prazo total do contrato referente à modalidade de crédito informada.;Texto;;Obrigatório;;"DIA
4+
SEMANA
5+
MES
6+
ANO
7+
SEM_PRAZO_TOTAL";1;1;"";Não permitido;string;MES;
8+
/data/totalNumberOfInstalments;totalNumberOfInstalments;"Prazo Total segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada. Deve corresponder à soma de `paidInstalments` + `pastDueInstalments` + `dueInstalments`.
9+
10+
[Restrição] Obrigatoriamente deve ser preenchido caso o `typeNumberOfInstalments` seja diferente de `SEM_PRAZO_TOTAL`.
11+
";Número;999999999;Condicional;;;0;1;" Obrigatoriamente deve ser preenchido caso o `typeNumberOfInstalments` seja diferente de `SEM_PRAZO_TOTAL`.
12+
";Não permitido;number;130632;
13+
/data/typeContractRemaining;typeContractRemaining;"Tipo de prazo remanescente do contrato referente à modalidade de crédito informada.
14+
";Texto;;Obrigatório;;"DIA
15+
SEMANA
16+
MES
17+
ANO
18+
SEM_PRAZO_REMANESCENTE";1;1;"";Não permitido;string;;
19+
/data/contractRemainingNumber;contractRemainingNumber;"Prazo Remanescente segundo o tipo (dia, semana, mês, ano) referente à Modalidade de Crédito informada.
20+
21+
[Restrição] Obrigatoriamente deve ser preenchido caso o typeContractRemaining seja diferente de SEM_PRAZO_REMANESCENTE.
22+
";Número;999999999;Condicional;;;0;1;" Obrigatoriamente deve ser preenchido caso o typeContractRemaining seja diferente de SEM_PRAZO_REMANESCENTE.
23+
";Não permitido;number;14600;
24+
/data/paidInstalments;paidInstalments;Quantidade de prestações pagas. (No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero);Número;999999;Obrigatório;;;1;1;"";Não permitido;number;73;
25+
/data/dueInstalments;dueInstalments;Quantidade de prestações a vencer.(No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero);Número;999999;Obrigatório;;;1;1;"";Não permitido;number;57;
26+
/data/pastDueInstalments;pastDueInstalments;Quantidade de prestações vencidas. (No caso de modalidades que não possuam parcelas, o número de prestações é igual a zero);Número;999999;Obrigatório;;;1;1;"";Não permitido;number;73;
27+
/data/balloonPayments;balloonPayments;Lista que traz as datas de vencimento e valor das parcelas não regulares do contrato da modalidade de crédito consultada;Lista;;Opcional;;;1;N;"";Não permitido;array;;
28+
/data/balloonPayments/dueDate;dueDate;"'Data de vencimento da parcela não regular a vencer do contrato da modalidade de crédito consultada, conforme especificação RFC-3339. p.ex. 2014-03-19'
29+
";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;2
30+
/data/balloonPayments/amount;amount;Valor monetário da parcela não regular a vencer.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
31+
/data/balloonPayments/amount/amount;amount;Valor monetário da parcela não regular a vencer. 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
32+
/data/balloonPayments/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;
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
2+
/data;data;Conjunto de informações referentes à identificação da operação de crédito de empréstimo;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
3+
/data/currency;currency;Moeda referente ao valor da garantia, segundo modelo ISO-4217. p.ex. 'BRL'. Todos os valores monetários informados estão representados com a moeda vigente do Brasil;Texto;3;Obrigatório;^(\w{3}){1}$;;1;1;"";Não permitido;string;BRL;
4+
/data/warrantyType;warrantyType;Denominação/Identificação do tipo da garantia que avaliza a Modalidade da Operação de Crédito contratada (Doc 3040, Anexo 12);Texto;;Obrigatório;;"CESSAO_DIREITOS_CREDITORIOS
5+
CAUCAO
6+
PENHOR
7+
ALIENACAO_FIDUCIARIA
8+
HIPOTECA
9+
OPERACOES_GARANTIDAS_PELO_GOVERNO
10+
OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS
11+
SEGUROS_ASSEMELHADOS
12+
GARANTIA_FIDEJUSSORIA
13+
BENS_ARRENDADOS
14+
GARANTIAS_INTERNACIONAIS
15+
OPERACOES_GARANTIDAS_OUTRAS_ENTIDADES
16+
ACORDOS_COMPENSACAO";1;1;"";Não permitido;string;CESSAO_DIREITOS_CREDITORIOS;
17+
/data/warrantySubType;warrantySubType;"Denominação/Identificação do sub tipo da garantia que avaliza a Modalidade da Operação de Crédito contratada (Doc 3040, Anexo 12).
18+
";Texto;;Obrigatório;;"ACOES_DEBENTURES
19+
ACORDOS_COMPENSACAO_LIQUIDACAO_OBRIGACOES
20+
APLICACOES_FINANCEIRAS_RENDA_FIXA
21+
APLICACOES_FINANCEIRAS_RENDA_VARIAVEL
22+
APOLICES_CREDITO_EXPORTACAO
23+
CCR_CONVENIO_CREDITOS_RECIPROCOS
24+
CHEQUES
25+
CIVIL
26+
DIREITOS_SOBRE_ALUGUEIS
27+
DEPOSITOS_A_VISTA_A_PRAZO_POUPANCA_OURO_TITULOS_PUBLICOS_FEDERAIS_ART_36
28+
DEPOSITO_TITULOS_EMITIDOS_ENTIDADES_ART_23
29+
DUPLICATAS
30+
EMD_ENTIDADES_MULTILATERAIS_DESENVOLVIMENTO_ART_37
31+
EQUIPAMENTOS
32+
ESTADUAL_OU_DISTRITAL
33+
FATURA_CARTAO_CREDITO
34+
FEDERAL
35+
FCVS_FUNDO_COMPENSACAO_VARIACOES_SALARIAIS
36+
FGI_FUNDO_GARANTIDOR_INVESTIMENTOS
37+
FGPC_FUNDO_GARANTIA_PROMOCAO_COMPETIT
38+
FGTS_FUNDO_GARANTIA_TEMPO_SERVICO
39+
FUNDO_GARANTIDOR_AVAL
40+
GARANTIA_PRESTADA_FGPC_LEI_9531_ART_37
41+
GARANTIA_PRESTADA_FUNDOS_QUAISQUER_OUTROS_MECANISMOS_COBERTURA_RISCO_CREDITO_ART_37
42+
GARANTIA_PRESTADA_TESOURO_NACIONAL_OU_BACEN_ART_37_BENS_DIREITOS_INTEGRANTES_PATRIMONIO_AFETACAO
43+
IMOVEIS
44+
IMOVEIS_RESIDENCIAIS
45+
MITIGADORAS
46+
MUNICIPAL
47+
NAO_MITIGADORAS
48+
NOTAS_PROMISSORIAS_OUTROS_DIREITOS_CREDITO
49+
OUTRAS
50+
OUTROS
51+
OUTROS_BENS
52+
OUTROS_GRAUS
53+
OUTROS_IMOVEIS
54+
OUTROS_SEGUROS_ASSEMELHADOS
55+
PESSOA_FISICA
56+
PESSOA_FISICA_EXTERIOR
57+
PESSOA_JURIDICA
58+
PESSOA_JURIDICA_EXTERIOR
59+
PRIMEIRO_GRAU_BENS_DIREITOS_INTEGRANTES_PATRIMONIO_AFETACAO
60+
PRIMEIRO_GRAU_IMOVEIS_RESIDENCIAIS
61+
PRIMEIRO_GRAU_OUTROS
62+
PROAGRO
63+
PRODUTOS_AGROPECUARIOS_COM_WARRANT
64+
PRODUTOS_AGROPECUARIOS_SEM_WARRANT
65+
SBCE_SOCIEDADE_BRASILEIRA_CREDITO_EXPORTAÇÃO
66+
SEGURO_RURAL
67+
SEM_SUB_TIPO_GARANTIA
68+
TRIBUTOS_RECEITAS_ORCAMENTARIAS
69+
VEICULOS
70+
VEICULOS_AUTOMOTORES";1;1;"";Não permitido;string;NOTAS_PROMISSORIAS_OUTROS_DIREITOS_CREDITO;
71+
/data/warrantyAmount;warrantyAmount;"Valor original da garantia. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
72+
73+
[Restrição] Para casos em que warrantyType for igual a ""GARANTIA_FIDEJUSSORIA"" o valor da garantia corresponde a uma porcentagem do total garantido.
74+
Dessa forma, os casos de garantia fidejussória para os quais não é possível determinar um valor monetário para a garantia devem ser preenchidos com 0.00.
75+
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;" Para casos em que warrantyType for igual a ""GARANTIA_FIDEJUSSORIA"" o valor da garantia corresponde a uma porcentagem do total garantido.
76+
Dessa forma, os casos de garantia fidejussória para os quais não é possível determinar um valor monetário para a garantia devem ser preenchidos com 0.00.
77+
";Não permitido;string;1000.0400;4

0 commit comments

Comments
 (0)