Visão Geral da Linha de Crédito

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
idIdentificador único da linha de créditostring
borrowerIdIdentificador único do Borrower atrelado a linha de créditostring
financialInstitutionInstituição financeira que realiza o desembolso
Visão Geral da Instituição Financeira
string
availableCreditLimitLimite de crédito disponível para a linha de créditodecimal
totalCreditLimitLimite total de crédito para a linha de créditodecimal
tpvVolume total de pagamentosdecimal
interestRateTaxa de jurosdecimal
creationDateData de criação da linha de créditodatetime
statusEstado atual da linha de créditostring
minMonthsToExpireContractPrazo mínimo em meses para expirar o contratoint
maxMonthsToExpireContractPrazo máximo em meses para expirar o contratoint
expectedSettlementBeforeContractExpirationInMonthsExpectativa de quitação antes da expiração do contrato em mesesint
disbursementConfigurações de desembolsoobject
repaymentConfigurações de reembolsoobject
warrantyConfigurações de garantiaobject
taxConfigurações de taxaobject
fundingSourceOrigem do recurso financeiro para realização do Desembolso
Possíveis valores:
"Stone"
"BNDES"
string
repayment.initialGracePeriodPeríodo para configuração de carência após desembolsoobject
repayment.methodMétodo de pagamento do empréstimo.string
repayment.repaymentAcquirersAdquirentes de origem das transações a serem retidas. (Ex:. Stone, All)string
repayment.ExternalAccountIdId externo da conta de reembolsosstring
repayment.isMaximumMonthlyRetentionAmountEnabledFlag para teto de retenção mensal. Caso true, empréstimos criados com essa linha de crédito terão um teto mensal de retençãoboolean
cancellationDateData de cancelamento da linha de créditodatetime
cancellationReasonMotivo de cancelamento da linha de créditostring
isEndorsementsEnabledFlag para indicar se a linha de crédito possui avalistaboolean
repayment.recommendedMinimumMonthlyPaymentConfigurações do piso do empréstimoobject
repayment.recommendedMinimumMonthlyPayment.coverageIndexÍndice de cobertura o qual o cálculo do piso usará como base para aumentar/diminuir o risco do empréstimodecimal
repayment.recommendedMinimumMonthlyPayment.isEnabledIndica se permitirá calcular o pisobool
repayment.recommendedMinimumMonthlyPayment.ProportionalConfigurationConfiguração de proporcionalidade do piso o qual será utilizado no empréstimo para calcular o proporcional de piso dado o período informadoobject
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.StepsEtapas de uma configuração de proporcionalidadeobject
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps[0].IndexÍndice de proporcionalidadedecimal
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps[0].StartDayDia de início da etapa de configuraçãoint
repayment.recommendedMinimumMonthlyPayment.ProportionalConfiguration.Steps[0].EndDayDia de início da etapa de configuraçãoint

Estados

StatusDescrição
ActiveLinha de crédito está disponível gerar empréstimos
InactiveLinha de crédito está cancelada e não pode mais ser utilizada
ProcessingEstado 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)

TipoDescrição
OfferExpirationExpiração da oferta de linha de crédito.
OfferAcceptedLinha de crédito foi utilizada para a contratação de um empréstimo
InvalidRepaymentAccountIdId 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
        }
    ]
}