Manual do Dev
InstitucionalBlogService DeskStatus Page

Simulação de parcelamentos de uma fatura

stable

Suggest Edits

Este endpoint permite que o cliente do parceiro Bankly simule os possíveis parcelamentos de uma fatura.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

  • A fatura do cliente esteja fechada;
  • A fatura seja elegível a parcelamento.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/installments \ 

--request POST \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/installments' \ 
--header 'Authorization:  Bearer {Token}' \ 
--header 'accept: appication/json' \ 
--header 'api-version: 1' 
--data '{
     "minTerm": 2, 
     "maxTerm": 5, 
     "downPayment": 20.0 
} '

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

ScopeDescrição
invoice.readConcede acesso para realizar consultas referentes à gestão de faturas.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

NomeTipoDescrição
statementIdpathObrigatório. Identificador único da fatura, retornado na consulta de todas as faturas.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescriçãoEspecificação
minTermintegerObrigatório. Número mínimo de parcelas a serem antecipadas.Mínimo de duas parcelas.
maxTermintegerObrigatório. Número máximo de parcelas a serem antecipadas.Mínimo de duas parcelas.
downPaymentnumberValor de entrada para simulação.decimal (18,4)

🚧

Importante

Se o número máximo de parcelas (maxTerm) informado exceder o permitido pela configuração do programa vinculado à fatura, será retornado apenas o número máximo de parcelas permitido.

{ 
     "minTerm": 2, 
     "maxTerm": 4, 
     "downPayment": 20.0
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e retornará uma lista com os possíveis parcelamentos e suas informações.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescriçãoNúmero máximo de caracteres
paymentOptionIdintegerIdentificador único da opção de pagamento.10
statementIdintegerIdentificador único da fatura.10
paymentTypestringOpção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada) e “InstallmentWithoutEntry” (parcelado sem entrada).40
valuenumberValor a ser pago (no caso de parcelamento, será a entrada).decimal (18,4)
creditOfferobjectObjeto que contém informações sobre a proposta de parcelamento da fatura.—
creditOffer.creditOfferIdintegerIdentificador único da proposta.10
creditOffer.externalOperationIdstringIdentificador externo da operação.40
creditOffer.externalOfferIdstringIdentificador externo da proposta.40
creditOffer.externalOfferTypestringTipo da proposta externa retornada, que pode ser “Variable” (referente à proposta de parcelamento) ou “Fixed” (referente à proposta de crédito rotativo).50
creditOffer.amountCurrencystringCódigo da moeda com base na ISO-4217 (exemplo: BRL).4
creditOffer.amountDuenumberValor contratado da proposta mais o valor total de juros (pode ou não conter TAC).decimal (18,4)
creditOffer.annualCetnumberCET (custo efetivo total) da contratação calculado ao ano.decimal (18,4)
creditOffer.annualInterestRatenumberTaxa de juros anual da contratação.decimal (18,4)
creditOffer.cetnumberCET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas.decimal (18,4)
creditOffer.disbursementDatestringData prevista para o desembolso da proposta.29
creditOffer.externalCreatedAtstringData do cálculo da proposta, no formato ISO 8601.29
creditOffer.externalExpiresAtstringData de expiração da proposta, no formato ISO 8601.29
creditOffer.firstPaymentDatestringData do primeiro pagamento da proposta, no formato ISO 8601.29
creditOffer.graceDaysintegerQuantidade de dias para a carência do primeiro pagamento.30
creditOffer.lastPaymentDatestringData do último pagamento da proposta, no formato ISO 8601.292
creditOffer.loanAmountnumberValor do crédito solicitado para contratação.decimal (18,4)
creditOffer.monthlyInterestRatenumberTaxa de juros mensal da contratação.decimal (18,4)
creditOffer.operationCostAmountnumberCusto de processamento da operação.decimal (18,4)
creditOffer.retentionRatenumberIndica o percentual de retenção da proposta.decimal (18,4)
creditOffer.termintegerQuantidade de parcelas da proposta.2
creditOffer.totalInterestAmountnumberValor total de juros a ser pago na contratação.decimal (18,4)
creditOffer.totalPaymentAmountnumberValor total a ser pago no final do contrato (se aplicável ao produto).decimal (18,4)
creditOffer.iofTotalAmountnumberValor final do cálculo do IOF.decimal (18,4)
creditOffer.iofTotalPercentagenumberValor percentual do IOF, se aplicável.decimal (18,4)
creditOffer.confirmedOfferbooleanInforma se a oferta está confirmada.—
creditOffer.diaryIofnumberInforma o percentual do IOF diário.decimal (18,4)
creditOffer.fixedIofnumberInforma o percentual do IOF fixo.decimal (18,4)
creditOffer.Installments[]array of objectsLista de objetos contendo os parcelamentos e suas informações.—
creditOffer.Installments[].creditOfferIdintegerIdentificador único da proposta.20
creditOffer.Installments[].amortizationAmountnumberValor da amortização no contrato.decimal (18,4)
creditOffer.Installments[].dueDatestringData de vencimento da parcela, no formato ISO 8601.29
creditOffer.Installments[].interestAmountnumberValor dos juros da parcela.decimal (18,4)
creditOffer.Installments[].iofAmountnumberValor do IOF da parcela.decimal (18,4)
creditOffer.Installments[].paymentAmountnumberValor da parcela.decimal (18,4)
creditOffer.Installments[].installmentNumberintegerNúmero da parcela.2
[ 
  { 
    "paymentOptionId": 0, 
    "statementId": 0, 
    "paymentType": "Cash", 
    "value": 0.0, 
    "creditOffer": { 
      "creditOfferId": 0, 
      "externalOperationId": "string", 
      "externalOfferId": "string", 
      "externalOfferType": "string", 
      "amountCurrency": "string", 
      "amountDue": 0.0, 
      "annualCet": 0.0, 
      "annualInterestRate": 0.0, 
      "cet": 0.0, 
      "disbursementDate": "2025-04-28T00:00:00+00:00", 
      "externalCreatedAt": "2025-04-28T00:00:00+00:00", 
      "externalExpiresAt": "2025-04-28T00:00:00+00:00", 
      "firstPaymentDate": "2025-04-28T00:00:00+00:00", 
      "graceDays": 0, 
      "lastPaymentDate": "2025-04-28T00:00:00+00:00", 
      "loanAmount": 0.0, 
      "monthlyInterestRate": 0, 
      "operationCostAmount": 0, 
      "retentionRate": 0, 
      "term": 0, 
      "totalInterestAmount": 0, 
      "totalPaymentAmount": 0, 
      "iofTotalAmount": 0, 
      "iofTotalPercentage": 0, 
      "confirmedOffer": true,
      "diaryIof": 0.5,
      "fixedIof": 1.5,
      "installments": [ 
        { 
          "creditOfferId": 0, 
          "amortizationAmount": 0, 
          "dueDate": "2025-04-28T00:00:00+00:00", 
          "interestAmount": 0, 
          "iofAmount": 0, 
          "paymentAmount": 0, 
          "installmentNumber": 0 
        } 
      ] 
    } 
  } 
]

✅

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar alguns erros específicos, conforme a tabela a seguir:

Status CodeCódigoMensagemDescrição
400CONTRACT_IS_IN_CRELIQContract from statment is Creliq status.Contrato da declaração está em status Creliq.
406STATEMENT_IS_NOT_CLOSEDStatement is not closed!A fatura não está fechada.
406CANT_MAKE_A_NEW_SIMULATIONCan't make a new simulation, a payment for the invoice has already been madeNão é possível realizar uma nova simulação, pois já existe um pagamento atrelado à fatura.
406INVALID_ENTRY_TYPE_FOR_PROGRAMThe program associated with the invoice does not allow custom entryO programa associado à fatura não permite entrada personalizada.
406ENTRY_TYPE_NOT_CONFIGUED_FOR_PROGRAMThe program associated with the invoice have not configured custom entry settingsO programa vinculado à fatura não foi configurado para permitir entrada personalizada.
406DOWN_PAYMENT_MINIMAL_NOT_ALLOWEDThe down payment amount cannot be less than the allowed minimumO valor de entrada não pode ser menor que o permitido.
406INVALID_DOWN_PAYMENT_AMOUNTThe down payment amount cannot be equal to another active credit offer's down paymentO valor de entrada não pode ser idêntico ao valor de entrada de outra oferta de crédito ativa.
406DOWN_PAYMENT_CANNOT_BE_EQUAL_AMOUNT_MINIMUMThe down payment amount cannot be equal of amount minimumO valor da entrada não pode ser igual ao valor mínimo da fatura.
406EXISTING_CREDIT_OFFER_WITH_PAYMENTCan't make a new simulation, a payment for an active credit offer has already been madeNão é possível realizar uma nova simulação, pois já existe um pagamento atrelado à alguma oferta de crédito ativa.
406SIMULATION_ALREADY_MADEA simulation already exists with the provided custom entryJá existe uma simulação com a entrada personalizada fornecida.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated 23 days ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados