Um Loan representa um empréstimo tomado por um Borrower que é gerado após aceitar uma Proposal na simulação. O empréstimo está sempre associado a uma CreditLine que define todas as condições iniciais da oferta. E uma CreditLine é sempre oferecida por uma FinancialInstitution. Logo o objeto de empréstimo sempre todos esses campos.
AffiliationKey e AffiliationCode serão descontinuados!
Não utilizem qualquer referencia a affiliationKey ou affiliationCode de qualquer resposta de qualquer endpoint do crédito. Esses campos serão descontinuados.
Objeto
Exemplo:
{
"id": "jpxyxa42fvfg416vgzvraydn3",
"creditLineId": "jpxyx9wau44465q8jdjk4h86y",
"label": "Empréstimo",
"financialInstitution": {
"id": 1,
"name": "BMP Money Plus"
},
"borrower": {
"id": "jpxyx9srnzeg7yhjjnewzqg51",
"document": "71446344320163",
"name": "NITEROI RUGBY FOOTBALL CLUBE 71446344320163",
"fantasyName": "NITEROI RUGBY 71446344320163",
"phoneNumber": "21981340010",
"email": "[email protected]",
"address": {
"id": "jpxyx9st1ygub3phyfz5627jh",
"streetName": "Rua Presidente Backer",
"streetNumber": "S/N",
"complement": "EST CAIO MARTINS S3",
"neighborhood": "Icaraí",
"city": "Niterói",
"state": "RJ",
"postalCode": "24220-041"
},
"creationDate": "2020-03-02T20:42:15",
"lastUpdateDate": "2020-03-02T20:42:16",
"status": "Active",
"documentType": {
"id": 0,
"name": "CNPJ"
}
},
"signer": {
"id": "jpxyxa42fvdwfs21te7uhbkz3",
"name": "NITEROI RUGBY FOOTBALL CLUBE 71446344320163",
"documentNumber": "71446344320163",
"phoneNumber": "21981340010",
"email": "[email protected]",
"ipAddress": "8.8.8.8"
},
"borrowerId": "jpxyx9srnzeg7yhjjnewzqg51",
"proposalId": "jpxyxa1p5a6fd6xepk2zbzh94",
"dueDate": "2020-12-02",
"maximumDisbursementDate": "2020-03-03T00:00:00",
"creditAmount": 10000.0,
"interestRate": 3.99,
"annualInterestRate": 50.0,
"contractNumber": 0,
"contractUri": "https://credit.stone.com.br/api/v3/borrowers/jpxyx9srnzeg7yhjjnewzqg51/proposals/jpxyxa1p5a6fd6xepk2zbzh94/contract",
"creationDate": "2020-03-02T20:42:50",
"lastUpdateDate": "2020-03-09T19:33:07",
"settlementDate": "2020-07-07",
"lastDebtAmountProcessingDate": "2020-03-09T19:33:07",
"status": "Active",
"statusDescription": "Ativo",
"retentionRate": 3.9,
"totalPaidAmount": 700.0,
"currentDebtAmount": 9531.08,
"presentValueDebtAmount": 9531.08,
"lastPresentValueDebtAmountProcessingDate": "2020-03-09T19:33:07",
"expectedSettlementDate": "2021-06-16",
"monthlyTotalEffectiveCostRate": 4.45,
"annualTotalEffectiveCostRate": 68.71,
"operationFeeAmount": 100.0,
"taxAmount": 113.0,
"disbursementDate": "2020-03-02",
"lastRepaymentDate": "2020-03-09T19:33:06",
"lender": {
"id": "FIDC",
"name": "FIDC Stone",
"document": "14211508000143"
},
"repaymentMethod": "Balance Retention",
"disbursement": {
"bankAccount": {
"id": "jpyzy1fvpfb7cjsnjrzs5vz7u",
"bankNumber": "197",
"bankName": "Banco do Brasil S.A.",
"branchNumber": "0102",
"branchDigit": "5",
"accountNumber": "000033224",
"accountDigit": "0",
"legalEntity": {},
"accountType": "Checking"
}
},
"warranty": {
"bankAccount": {
"id": "jpyzy1fvpfb7cjsnjrzs5vz7u",
"bankNumber": "197",
"bankName": "Banco do Brasil S.A.",
"branchNumber": "0102",
"branchDigit": "5",
"accountNumber": "000033224",
"accountDigit": "0",
"legalEntity": {},
"accountType": "Checking"
},
"method": "BankLock"
},
"tax": {
"additionalIofRatePercentage": 1.0,
"dailyIofRatePercentage": 1.0
},
"repayment": {
"method": "Balance Retention",
"repaymentAcquirers": "Stone",
"isMaximumMonthlyRetentionAmountEnabled": false,
"maximumMonthlyRetentionAmount": 2755.83,
"maximumRetentionAmount": 2755.83,
"monthlyRetentionDueDate": "2021-04-30",
"startDate": "2021-04-30",
"status": "Scheduled",
"initialGracePeriodInDays": "30",
"isRetentionEnabled": true,
"retentionDeactivationDate": "2021-04-20T19:30:09.0096673Z",
"monthlyDebitBalance": 50.0,
"totalRetainedAmountInMonth": 100.0,
"currentRetentionMonthlyCreditBalance": 100.0,
"recommendedMinimumMonthlyPayment": {
"coverageIndex": 2.0,
"isEnabled": true,
"amount": 450.0,
"proportionalConfiguration": {
"steps": [
{
"index": 0.5,
"startDay": 1,
"endDay": 31
}
]
}
}
},
"warrantyExecutionStatus": "Standby",
"interests": {
"interestRate": 3.99,
"annualInterestRate": 50.0,
"discountRule": {
"id": "jqa6tde1samh1c73u8ujr3wn2",
"discountRate": 10.0,
"startDate": "2021-06-10",
"endDate": "2021-06-12",
"createdBy": "[email protected]",
"creationDate": "2021-06-02T13:34:09",
"lastUpdateDate": "2021-06-02T13:34:09"
},
"isPreservingAccountingEntryHistory": false
}
}
Campos
| Campo | Descrição |
|---|---|
id | Identificador único do empréstimo |
creditLine | Dados sobre a linha de crédito utilizada |
financialInstitution | Instituição financeira que realiza o desembolso Visão Geral da Instituição Financeira |
lender | Dados sobre a Instituição Financeira que concedeu o crédito |
borrower | Dados sobre o mutuário que tomou o crédito |
signer | Dados sobre o usuário que aceitou a proposta e assinou o contrato |
bankAccount | Dados da conta bancária que recebe o desembolso. Veja BankAccount |
dueDate | Data de vencimento do contrato |
paymentTermInMonths | Prazo de pagamento até o vencimento do contrato em meses |
maximumDisbursementDate | Data máxima esperada para o desembolso |
creditAmount | Valor do crédito tomado |
interestRate | Taxa de juros ao mês (% am). Exemplo: 3,99% am é representado por 3.99 |
annualInterestRate | Taxa de juros ao ano (% aa). Exemplo: 50,00% aa é representado por 50,00 |
contractNumber | Número da CCB |
contractUri | Link para impressão do contrato |
creationDate | Data de criação do empréstimo |
lastUpdateDate | Data da última atualização do empréstimo |
lastDebtAmountProcessingDate | Data do último processamento do saldo devedor |
status | Estado atual do empréstimo. Conferir tabela abaixo |
retentionRate | Taxa de retenção combinada com o cliente sobre seus recebíveis para quitar o empréstimo |
totalPaidAmount | Montante total pago pelo cliente |
currentDebtAmount | Saldo devedor atual |
presentValueDebtAmount | Saldo devedor presente |
lastPresentValueDebtAmountProcessingDate | Data do último processamento do saldo devedor presente |
monthlyTotalEffectiveCostRate | Custo Efetivo Total (CET) mensal previsto na assinatura do contrato |
annualTotalEffectiveCostRate | Custo Efetivo Total (CET) anual previsto na assinatura do contrato |
operationFeeAmount | Tarifa de contratação |
taxAmount | IOF previsto na assinatura do contrato |
repaymentMethod | Estratégia de reembolso do empréstimo. Ex: Motor de Retenção ou Split de Transações |
suspension | Dados da suspensão associada a um Empréstimo. Esse campo só é visível para Empréstimos com status suspended, que é o caso do exemplo. |
disbursementDate | Data de desembolso do empréstimo |
lastRepaymentDate | Data do último reembolso do empréstimo |
disbursement | Dados sobre o processo de desembolso |
warranty | Dados sobre o mecanismo de garantia |
tax | Dados sobre as alíquotas de IOF aplicadas ao empréstimo |
settlementDate | Data de quitação do empréstimo, se quitado |
warrantyExecutionStatus | Estado da Execução de garantia de um empréstimo. Conferir a tabela "Estados de Execução de Garantia" abaixo. |
repayment.method | Método de reembolso. Maneira como cliente quita seu saldo devedor |
repayment.repaymentAcquirers | Origem dos recebíveis a serem retidos para quitação do empréstimo (Stone, All) |
repayment.isMaximumMonthlyRetentionAmountEnabled | Flag que indica se a contratação considera um teto mensal de retenção |
repayment.maximumMonthlyRetentionAmount | Teto mensal de retenção |
repayment.maximumRetentionAmount | Valor máximo de retenção atual do empréstimo. Esse valor deve ser sempre o menor valor entre o saldo devedor e o teto mensal de retenção |
repayment.monthlyRetentionDueDate | Data fim da retenção com teto mensal |
repayment.isRetentionEnabled | Flag que indica se a retenção atual do empréstimo está ativada(true) ou desativada(false) |
repayment.RetentionDeactivationDate | Data que a retenção foi desativada |
repayment.monthlyDebitBalance | Total que falta para atingir o teto mensal |
repayment.totalRetainedAmountInMonth | Total retido no mês(engloba 1 ou mais retenções caso houver) |
repayment.currentRetentionMonthlyCreditBalance | Total retido no mês pela retenção atual |
repayment.status | Status da coleta de reembolso. Conferir na tabela "Estados da coleta de reembolso" abaixo |
repayment.initialGracePeriodInDays | Dias de carência inicial que o empréstimo possui. |
repayment.startDate | O dia que o empréstimo irá começar a reter. |
repayment.recommendedMinimumMonthlyPayment | Configurações do piso do empréstimo |
repayment.recommendedMinimumMonthlyPayment.coverageIndex | Índice de cobertura o qual o cálculo do piso usará como base para aumentar/diminuir o risco do empréstimo |
repayment.recommendedMinimumMonthlyPayment.isEnabled | Indica se permitirá calcular o piso |
statusDescription | Descrição amigável para o Status do Loan |
warranty.method | Método de garantia do empréstimo. Valores possíveis: BankLock (Trava bancária) e Guarantee (Gravame) |
label | Nome customizável para o empréstimo |
| interests | Informações referentes a juros |
| interests.discountRule | Regra de desconto de juros vigente na data atual |
| expectedSettlementDate | Data esperada de quitação do contrato |
| isPreservingAccountingEntryHistory | Informa se o empréstimo está preservando o histórico contábil |
Estados
| Status | Descrição | StatusDescription |
|---|---|---|
Accepted | Cliente aceitou a proposta, assinou o contrato e o empréstimo foi gerado. | Em análise |
DisbursementRequested | O desembolso foi solicitado à Instituição Financeira | Em andamento |
DisbursementConfirmed | A Instituição Financeira confirmou o desembolso | Em andamento |
Active | Todo o setup do empréstimo foi concluído | Ativo |
Settled | Empréstimo quitado | Quitado |
Inactive | Empréstimo cancelado | Cancelado |
Suspended | Empréstimo suspenso | Suspenso |
Cancelled | Empréstimo cancelado | Cancelado |
Estados de Execução de Garantia
| Status | Descrição |
|---|---|
Standby | Status inicial da execução de garantia. Todo empréstimo nasce nessa situação e se encerra assim, caso não entre em execução de garantia em nenhum momento. |
Active | Indica que o empréstimo está sendo executado. Isso significa que estamos cumprindo o acordado em contrato em caso de inadimplência. No cenário de garantia em recebíveis, retemos a agenda do cliente a uma certa porcentagem afim de pagar a dívida em aberto |
Inactive | Nesse cenário o empréstimo já esteve em algum momento em execução de garantia, mas teve a mesma inativada, seja por renegociação ou qualquer outro motivo. Caso quitado nessa situação, o mesmo se mantém Inactive. |
Suspended | Esse status indica que o empréstimo está com a execução de garantia suspensa devido à suspensão do empréstimo. Por exemplo, no cenário de garantia em recebíveis, isso quer dizer que, por não estar retendo, o empréstimo não está sendo executado. Caso a retenção seja retomada, o seu status de execução volta para Active. Caso o empréstimo quite, ele é alterado para Done |
Done | Status final de um empréstimo que foi quitado enquanto em execução de garantia (seja ela suspensa ou não). |
Estados da coleta de reembolso
Estados da coleta de reembolso
| Status | Descrição |
|---|---|
| Scheduled | Significa que a coleta de reembolsos dos empréstimo está agendada para alguma data. |
| Active | Significa que a coleta de reembolsos dos empréstimo está ativa e que estão sendo coletados reembolsos através do método de retenção configurado no empréstimo. |
| Disabled | Significa que a coleta de reembolsos dos empréstimo está desligada. Isso pode acontecer por conta de um cancelamento, quitação do empréstimo ou então porquê o empréstimo atingiu o teto de retenção mensal. |
Contrato de Streaming dos dados do Empréstimo
Veja Streaming de dados
{
"Content":[
{
"Data":[
{
"CreationDate":"2020-05-26T21:27:27.7070988",
"BorrowerId":"jq12rebhrrbz8bhn634yq7cy4",
"LastUpdateDate":"2020-07-14T19:30:09.0096673Z",
"CancellationUserId":null,
"TotalPaidAmount":0.00,
"MaximumDisbursementDate":"2020-05-27T00:00:00",
"ContractNumber":1234,
"CreditAmount":20000.00,
"ContractUri":"https://partnerservices7456-8080-default.mock.blazemeter.com/reportscustom/stone/imprimirccb2?code=89a0ed8d-80d3-4540-a6b7-48f5e3ff8526",
"DisbursementDate":"2020-05-26T22:15:04.2002808Z",
"CurrentDebtAmount":21657.41,
"SignerId":"jq12rfch22efejz3v94pv2wnx",
"DueDate":"2021-02-26",
"LastCurrentDebtProcessingDate":"2020-07-14T19:30:09.0096673Z",
"Id":"jq12rfch22g55dvmqzmb1y664",
"CancellationDate":null,
"LenderId":"FIDC",
"LenderName":"FIDC Stone",
"LenderDocument":"31847367000179",
"ProposalId":"jq12rf3nrvv5dkq9bbtuvm3n1",
"TotalEffectiveCostRate":4.540000,
"Status":"Active",
"RetentionRate":6.000000,
"AnnualTotalEffectiveCostRate":70.320000,
"CreditLineId":"jq12retpbe6ydkxwn842qp5dd",
"TaxAmount":302.32,
"OperationFeeAmount":200.00,
"CancellationReason":null,
"BankAccountId":"jq12rf3uj2fm6jm9s17ue5x3k",
"FinancialInstitutionId":"BrasilMoneyPlusStaging",
"InterestRate":3.990000,
"RepaymentStrategy":"TransactionSplit",
"RetentionCorrelationId":null,
"Version":148,
"LastRepaymentDate":null,
"SettlementDate":null,
"RepaymentAcquirerFilter":"Stone",
"ExternalRepaymentAccountId":"e48b05d4-ea52-4263-890aca115ccd6c20",
"IsMaximumMonthlyRetentionAmountEnabled":false,
"MaximumMonthlyRetentionAmount":85.94,
"MaximumRetentionAmount":85.94,
"WarrantyMethod":"BankLock",
"MonthlyRetentionDueDate": "2021-04-30",
"IsRetentionEnabled": true,
"RetentionDeactivationDate": "2021-04-20T19:30:09.0096673Z",
"RemainingAmountToReachMonthlyRetentionCeil": 50.00,
"TotalRetainedAmountInMonth": 100.00,
"TotalRetainedAmountInMonthByCurrentRetention": 100.00,
"PresentValueDebtAmount": 21657.41,
"StreamDate":"2020-07-14T19:30:08.3136058Z"
}
],
"SchemaName":"loan",
"SchemaVersion":1
}
]
}
Campos
CreationDate | DateTime |
BorrowerId | string |
LastUpdateDate | DateTime |
CancellationUserId | string |
TotalPaidAmount | decimal |
MaximumDisbursementDate | DateTime |
ContractNumber | long |
CreditAmount | decimal |
ContractUri | string |
DisbursementDate | DateTime |
CurrentDebtAmount | decimal |
SignerId | string |
DueDate | Date |
LastCurrentDebtProcessingDate | DateTime |
Id | string |
CancellationDate | DateTime |
LenderId | string |
LenderName | string |
LenderDocument | string |
ProposalId | string |
TotalEffectiveCostRate | decimal |
Status | string |
RetentionRate | decimal |
AnnualTotalEffectiveCostRate | decimal |
CreditLineId | string |
TaxAmount | decimal |
OperationFeeAmount | decimal |
CancellationReason | string |
BankAccountId | string |
FinancialInstitutionId | string |
InterestRate | decimal |
RepaymentStrategy | string |
RetentionCorrelationId | string |
Version | Int |
LastRepaymentDate | DateTime |
SettlementDate | DateTime |
PresentValueDebtAmount | decimal |
StreamDate | DateTime |
WarrantyMethod | string |