A entidade CreditLine
representa um crédito pré-aprovado por uma Instituição Financeira para um Borrower
. Na linha de crédito são definidos o limite disponível, taxa de juros e todas as condições para que seja tomado um empréstimo. Um Borrower
pode ter várias linhas de crédito ativas, porém somente uma ativa por Instituição Financeira.
Objeto
{
"id":"jpx9qa4g1xcq78crmtht9tmza",
"borrowerId":"jptjhhbf19vq1zr9mhpmdn5kf",
"financialInstitution":{
"id":3,
"name":"Stone SCD"
},
"availableCreditLimit":20000,
"totalCreditLimit":20000,
"tpv":20000,
"interestRate":3.99,
"creationDate":"2020-02-03T14:06:34Z",
"lastUpdateDate":"2020-02-03T14:06:34Z",
"cancellationDate":"2020-02-03T14:06:34Z",
"cancellationReason": "OfferAccepted",
"status":"Inactive",
"minMonthsToExpireContract":7,
"maxMonthsToExpireContract":15,
"expectedSettlementBeforeContractExpirationInMonths": 0,
"repayment":{
"method":"StoneBankingRetention",
"repaymentAcquirers": "Stone",
"initialGracePeriod": {
"minimumInDays": 10,
"maximumInDays": 30
},
"recommendedMinimumMonthlyPayment": {
"coverageIndex": 2.0,
"isEnabled": true,
"proportionalConfiguration":{
"steps": [
{
"index": 0.5,
"startDay": 1,
"endDay": 31
}
]
}
},
"externalAccountId": "99e76c21-90d9-4e0b-b23e-68f5952a8f9a",
"isMaximumMonthlyRetentionAmountEnabled": false
},
"disbursement":{
"bankAccount":{
"id":"jpx9qa4g1xcq78crmtht9tmza",
"bankNumber":"187",
"branchNumber":"4864",
"branchDigit":"",
"accountNumber":"89913",
"accountDigit":"5",
"accountType":"Payments",
"legalEntity":{
"name":"João Stone",
"documentType":"CPF",
"documentNumber":"03901140573"
}
},
"fundingSource": {
"name": "Stone"
}
},
"warranty":{
"bankAccount":{
"id":"jpx9qa4g1xcq78crmtht9tmza",
"bankNumber":"187",
"branchNumber":"4864",
"branchDigit":"",
"accountNumber":"89913",
"accountDigit":"5",
"accountType":"Payments",
"legalEntity":{
"name":"João Stone",
"documentType":"CPF",
"documentNumber":"03901140573"
}
}
},
"tax":{
"additionalIofRatePercentage":0.00,
"dailyIofRatePercentage":0.00
},
"isEndorsementsEnabled":false
}
Campos
Tipo de Dados | ||
---|---|---|
id | Identificador único da linha de crédito | string |
borrowerId | Identificador único do Borrower atrelado a linha de crédito | string |
financialInstitution | Instituição financeira que realiza o desembolso Visão Geral da Instituição Financeira | string |
availableCreditLimit | Limite de crédito disponível para a linha de crédito | decimal |
totalCreditLimit | Limite total de crédito para a linha de crédito | decimal |
tpv | Volume total de pagamentos | decimal |
interestRate | Taxa de juros | decimal |
creationDate | Data de criação da linha de crédito | datetime |
status | Estado atual da linha de crédito | string |
minMonthsToExpireContract | Prazo mínimo em meses para expirar o contrato | int |
maxMonthsToExpireContract | Prazo máximo em meses para expirar o contrato | int |
expectedSettlementBeforeContractExpirationInMonths | Expectativa de quitação antes da expiração do contrato em meses | int |
disbursement | Configurações de desembolso | object |
repayment | Configurações de reembolso | object |
warranty | Configurações de garantia | object |
tax | Configurações de taxa | object |
fundingSource | Origem do recurso financeiro para realização do Desembolso Possíveis valores: "Stone" "BNDES" | string |
repayment.initialGracePeriod | Período para configuração de carência após desembolso | object |
repayment.method | Método de pagamento do empréstimo. | string |
repayment.repaymentAcquirers | Adquirentes de origem das transações a serem retidas. (Ex:. Stone, All) | string |
repayment.ExternalAccountId | Id externo da conta de reembolsos | string |
repayment.isMaximumMonthlyRetentionAmountEnabled | Flag para teto de retenção mensal. Caso true , empréstimos criados com essa linha de crédito terão um teto mensal de retenção | boolean |
cancellationDate | Data de cancelamento da linha de crédito | datetime |
cancellationReason | Motivo de cancelamento da linha de crédito | string |
isEndorsementsEnabled | Flag para indicar se a linha de crédito possui avalista | boolean |
repayment.recommendedMinimumMonthlyPayment | Configurações do piso do empréstimo | object |
repayment.recommendedMinimumMonthlyPayment.coverageIndex | Índice de cobertura o qual o cálculo do piso usará como base para aumentar/diminuir o risco do empréstimo | decimal |
repayment.recommendedMinimumMonthlyPayment.isEnabled | Indica se permitirá calcular o piso | bool |
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration | Configuração de proporcionalidade do piso o qual será utilizado no empréstimo para calcular o proporcional de piso dado o período informado | object |
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps | Etapas de uma configuração de proporcionalidade | object |
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps[0].Index | Índice de proporcionalidade | decimal |
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps[0].StartDay | Dia de início da etapa de configuração | int |
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps[0].EndDay | Dia de início da etapa de configuração | int |
Estados
Status | Descrição |
---|---|
Active | Linha de crédito está disponível gerar empréstimos |
Inactive | Linha de crédito está cancelada e não pode mais ser utilizada |
Processing | Estado inicial da linha de Crédito. Ela permanece nesse estado enquanto a validade de seus dados ainda não foi verificada. Após esse momento a linha de crédito se torna Active ou Inactive , dependendo do resultado da validação. |
Motivos de cancelamento de uma linha de Crédito (CancellationReason)
Tipo | Descrição |
---|---|
OfferExpiration | Expiração da oferta de linha de crédito. |
OfferAccepted | Linha de crédito foi utilizada para a contratação de um empréstimo |
InvalidRepaymentAccountId | Id externo da conta de reembolso não é válido |
Contrato de Streaming dos dados da Linha de Crédito
Veja Streaming de dados
{
"Content": [
{
"Data": [
{
"Status": "Inactive",
"Id": "jq29fvsfn21p37kg8e9rdqzcg",
"BorrowerId": "jq25w5ms76jt4h5dbck3579cu",
"Tpv": 33333.00,
"AvailableCreditLimit": 33333.00,
"CreationDate": "2020-07-15T04:24:18.6749947",
"FinancialInstitutionId": "SCD",
"InterestRate": 3.000000,
"LastUpdateDate": "2020-07-15T04:24:26.2580747Z",
"CreditAnalisysId": null,
"TotalCreditLimit": 33333.00,
"IsMaximumMonthlyRetentionAmountEnabled":false,
"Version": 30,
"MinMonthsToExpireContract": 9,
"MaxMonthsToExpireContract": 9,
"expectedSettlementBeforeContractExpirationInMonths": 0,
"cancellationDate":"2020-02-03T14:06:34Z",
"cancellationReason": "OfferAccepted",
"IsRecommendedMinimumMonthlyPaymentEnabled",
"RecommendedMinimumMonthlyPaymentCoverageIndex",
"StreamDate": "2020-07-15T04:24:26.5871595Z",
}
],
"SchemaName": "creditline",
"SchemaVersion": 1
}
]
}