Skip to content

feat(Loans): EOF-766 - PDC420 - Esclarecer os valores que deverão ser considerados no campo contractAmount da API Empréstimos #4933

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data,,,,,,,,,,,,,,,links,,,,,meta,,
data,,,,,,,,,,,,,,,links,,,,,meta,,
paidInstalments,contractOutstandingBalance,releases,,,,,,,,,,,,lastUpdatedcontractOutstandingBalanceDateTime,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
,,paymentId,isOverParcelPayment,instalmentId,paidDate,currency,paidAmount,overParcel,,,,,,,,,,,,,,
,,,,,,,,fees,,,charges,,,,,,,,,,,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data,,,,,,,,,,links,,,,,meta,,
data,,,,,,,,,,links,,,,,meta,,
typeNumberOfInstalments,totalNumberOfInstalments,typeContractRemaining,contractRemainingNumber,paidInstalments,dueInstalments,pastDueInstalments,balloonPayments,,,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
,,,,,,,dueDate,amount,,,,,,,,,
,,,,,,,,amount,currency,,,,,,,,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
data,,,,links,,,,,meta,,
data,,,,links,,,,,meta,,
currency,warrantyType,warrantySubType,warrantyAmount,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
BRL,CESSAO_DIREITOS_CREDITORIOS,NOTAS_PROMISSORIAS_OUTROS_DIREITOS_CREDITO,1000.0400,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,1,1,2021-05-21T08:30:00Z
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,links,,,,,meta,,
data,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,links,,,,,meta,,
contractNumber,ipocCode,productName,productType,productSubType,productSubTypeCategory,contractDate,disbursementDates,settlementDate,contractAmount,currency,dueDate,instalmentPeriodicity,instalmentPeriodicityAdditionalInfo,firstInstalmentDueDate,CET,hasInsuranceContracted,amortizationScheduled,amortizationScheduledAdditionalInfo,cnpjConsignee,interestRates,,,,,,,,,,contractedFees,,,,,,contractedFinanceCharges,,,nextInstalmentAmount,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
,,,,,,,,,,,,,,,,,,,,taxType,interestRateType,taxPeriodicity,calculation,referentialRateIndexerType,referentialRateIndexerSubType,referentialRateIndexerAdditionalInfo,preFixedRate,postFixedRate,additionalInfo,feeName,feeCode,feeChargeType,feeCharge,feeAmount,feeRate,chargeType,chargeAdditionalInfo,chargeRate,,,,,,,,,
1.32493E+12,92792126019929279212650822221989319252576,Crédito Pessoal Consignado,EMPRESTIMOS,CREDITO_PESSOAL_COM_CONSIGNACAO,CREDITO_PESSOAL_CLEAN,2018-01-05,2018-01-15,2018-01-15,1000.0400,BRL,2028-01-15,SEMANAL,Informações adicionais sobre periodicidade,2018-02-15,0.290000,TRUE,SAC,Informações complementares relativa à amortização do tipo 'OUTROS',6.0501E+13,EFETIVA,SIMPLES,AA,21/252,PRE_FIXADO,TJLP,Informações adicionais,0.600000,0.550000,Informações adicionais,Renovação de cadastro,CADASTRO,UNICA,MINIMO,100000.0400,0.062000,JUROS_REMUNERATORIOS_POR_ATRASO,Informações adicionais sobre encargos.,0.070000,1000.0400,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,1,1,2021-05-21T08:30:00Z
2 changes: 1 addition & 1 deletion dictionary/example/example_loansGetContracts_v2.5.csv
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
data,,,,,,,links,,,,,meta,,
data,,,,,,,links,,,,,meta,,
contractId,brandName,companyCnpj,productType,productSubType,productSubTypeCategory,ipocCode,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
92792126019929279212650822221989319252576,Organização A,2.11282E+13,EMPRESTIMOS,CREDITO_PESSOAL_COM_CONSIGNACAO,CREDITO_PESSOAL_CLEAN,92792126019929279212650822221989319252576,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,1,1,2021-05-21T08:30:00Z
2 changes: 1 addition & 1 deletion dictionary/example/examples_loans_contract.csv
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
data,,,,,,,links,,,,,meta,,
data,,,,,,,links,,,,,meta,,
contractId,brandName,companyCnpj,productType,productSubType,productSubTypeCategory,ipocCode,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
92792126019929279212650822221989319252576,Organização A,2.11282E+13,EMPRESTIMOS,CREDITO_PESSOAL_COM_CONSIGNACAO,CREDITO_PESSOAL_CLEAN,92792126019929279212650822221989319252576,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,1,1,2021-05-21T08:30:00Z
2 changes: 1 addition & 1 deletion dictionary/example/examples_loans_contract_list.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,links,,,,,meta,,
data,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,links,,,,,meta,,
contractNumber,ipocCode,productName,productType,productSubType,productSubTypeCategory,contractDate,disbursementDates,settlementDate,contractAmount,currency,dueDate,instalmentPeriodicity,instalmentPeriodicityAdditionalInfo,firstInstalmentDueDate,CET,hasInsuranceContracted,amortizationScheduled,amortizationScheduledAdditionalInfo,cnpjConsignee,interestRates,,,,,,,,,,contractedFees,,,,,,contractedFinanceCharges,,,nextInstalmentAmount,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
,,,,,,,,,,,,,,,,,,,,taxType,interestRateType,taxPeriodicity,calculation,referentialRateIndexerType,referentialRateIndexerSubType,referentialRateIndexerAdditionalInfo,preFixedRate,postFixedRate,additionalInfo,feeName,feeCode,feeChargeType,feeCharge,feeAmount,feeRate,chargeType,chargeAdditionalInfo,chargeRate,,,,,,,,,
1.32493E+12,92792126019929279212650822221989319252576,Crédito Pessoal Consignado,EMPRESTIMOS,CREDITO_PESSOAL_COM_CONSIGNACAO,CREDITO_PESSOAL_CLEAN,2018-01-05,2018-01-15,2018-01-15,1000.0400,BRL,2028-01-15,SEMANAL,Informações adicionais sobre periodicidade,2018-02-15,0.290000,TRUE,SAC,Informações complementares relativa à amortização do tipo 'OUTROS',6.0501E+13,EFETIVA,SIMPLES,AA,21/252,PRE_FIXADO,TJLP,Informações adicionais,0.600000,0.550000,Informações adicionais,Renovação de cadastro,CADASTRO,UNICA,MINIMO,100000.0400,0.062000,JUROS_REMUNERATORIOS_POR_ATRASO,Informações adicionais sobre encargos.,0.070000,1000.0400,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,1,1,2021-05-21T08:30:00Z
2 changes: 1 addition & 1 deletion dictionary/example/examples_loans_payments.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data,,,,,,,,,,,,,,,links,,,,,meta,,
data,,,,,,,,,,,,,,,links,,,,,meta,,
paidInstalments,contractOutstandingBalance,releases,,,,,,,,,,,,lastUpdatedcontractOutstandingBalanceDateTime,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
,,paymentId,isOverParcelPayment,instalmentId,paidDate,currency,paidAmount,overParcel,,,,,,,,,,,,,,
,,,,,,,,fees,,,charges,,,,,,,,,,,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data,,,,,,,,,,links,,,,,meta,,
data,,,,,,,,,,links,,,,,meta,,
typeNumberOfInstalments,totalNumberOfInstalments,typeContractRemaining,contractRemainingNumber,paidInstalments,dueInstalments,pastDueInstalments,balloonPayments,,,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
,,,,,,,dueDate,amount,,,,,,,,,
,,,,,,,,amount,currency,,,,,,,,
Expand Down
2 changes: 1 addition & 1 deletion dictionary/example/examples_loans_warranties.csv
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
data,,,,,,,links,,,,,meta,,
data,,,,,,,links,,,,,meta,,
contractId,brandName,companyCnpj,productType,productSubType,productSubTypeCategory,ipocCode,self,first,prev,next,last,totalRecords,totalPages,requestDateTime
92792126019929279212650822221989319252576,Organização A,2.11282E+13,EMPRESTIMOS,CREDITO_PESSOAL_COM_CONSIGNACAO,CREDITO_PESSOAL_CLEAN,92792126019929279212650822221989319252576,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,1,1,2021-05-21T08:30:00Z
4 changes: 3 additions & 1 deletion dictionary/loansGetContractsContractIdPayments_v2.5.0.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
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;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;;
/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;
/data/contractOutstandingBalance;contractOutstandingBalance;Valor necessário para o cliente liquidar a dívida.;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;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).
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.
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/releases;releases;Lista dos pagamentos realizados no período;Lista;;Obrigatório;;;0;N;"";Não permitido;array;;
/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
/data/releases/isOverParcelPayment;isOverParcelPayment;Identifica se é um pagamento pactuado (false) ou avulso (true).;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
Expand Down
5 changes: 4 additions & 1 deletion dictionary/loansGetContractsContractId_v2.5.0.csv
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ OUTRO";1;1;"";Não permitido;string;CREDITO_PESSOAL_CLEAN;
";Lista;10;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;N;"";Não permitido;array;2018-01-15;
/data/settlementDate;settlementDate;"Data de liquidação da operação.
";Data;10;Opcional;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;0;1;"";Não permitido;string;2018-01-15;
/data/contractAmount;contractAmount;Valor contratado da operação. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais. Nos casos em que não houver este valor explícito no contrato do produto, enviar como 0.00;Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/data/contractAmount;contractAmount;"Valor contratado da operação. Não incluir valores de taxas, tarifas, encargos e seguros.
Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
Nos casos em que não houver este valor explícito no contrato do produto, enviar como 0.00
";Texto;20;Obrigatório;^\d{1,15}\.\d{2,4}$;;1;1;"";Não permitido;string;1000.0400;4
/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;Opcional;^(\w{3}){1}$;;0;1;"";Não permitido;string;BRL;
Expand Down
9 changes: 7 additions & 2 deletions swagger-apis/loans/2.5.0-beta.1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,10 @@ components:
maxLength: 20
minLength: 4
example: '1000.0400'
description: Valor contratado da operação. Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais. Nos casos em que não houver este valor explícito no contrato do produto, enviar como 0.00
description: |
Valor contratado da operação. Não incluir valores de taxas, tarifas, encargos e seguros.
Expresso em valor monetário com no mínimo 2 casas e no máximo 4 casas decimais.
Nos casos em que não houver este valor explícito no contrato do produto, enviar como 0.00
currency:
type: string
maxLength: 3
Expand Down Expand Up @@ -1149,7 +1152,9 @@ components:
maxLength: 20
minLength: 4
example: '1000.0400'
description: Valor necessário para o cliente liquidar a dívida.
description: |
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).
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.
releases:
type: array
minItems: 0
Expand Down
Loading