Simulação de parcelamentos de uma fatura

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

Requisição HTTP

GET 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'

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:

Scope	Descrição
`invoice.read`	Concede acesso para realizar consultas referentes à gestão de faturas.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`statementId`	`path`	Obrigatório. Identificador único da fatura.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

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:

Nome	Tipo	Descrição	Número máximo de caracteres
`paymentOptionId`	`integer`	Identificador único da opção de pagamento.	10
`statementId`	`integer`	Identificador único da fatura.	10
`paymentType`	`string`	Opção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada) e “InstallmentWithoutEntry” (parcelado sem entrada).	40
`value`	`number`	Valor a ser pago (no caso de parcelamento, será a entrada).	decimal (18,4)
`creditOffer`	`object`	Objeto que contém informações sobre a proposta de parcelamento da fatura.	—
`creditOffer.creditOfferId`	`integer`	Identificador único da proposta.	10
`creditOffer.externalOperationId`	`string`	Identificador externo da operação.	40
`creditOffer.externalOfferId`	`string`	Identificador externo da proposta.	40
`creditOffer.externalOfferType`	`string`	Tipo da proposta externa retornada, que pode ser “Variable” (referente à proposta de parcelamento) ou “Fixed” (referente à proposta de crédito rotativo).	50
`creditOffer.amountCurrency`	`string`	Código da moeda de acordo com a ISO-4217 (exemplo: BRL).	4
`creditOffer.amountDue`	`number`	Valor contratado da proposta mais o valor total de juros (pode ou não conter TAC).	decimal (18,4)
`creditOffer.annualCet`	`number`	CET (custo efetivo total) da contratação calculado ao ano.	decimal (18,4)
`creditOffer.annualInterestRate`	`number`	Taxa de juros anual da contratação.	decimal (18,4)
`creditOffer.cet`	`number`	CET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas.	decimal (18,4)
`creditOffer.disbursementDate`	`string`	Data prevista para o desembolso da proposta.	29
`creditOffer.externalCreatedAt`	`string`	Data do cálculo da proposta no formato ISO 8601.	29
`creditOffer.externalExpiresAt`	`string`	Data de expiração da proposta no formato ISO 8601.	29
`creditOffer.firstPaymentDate`	`string`	Data do primeiro pagamento da proposta no formato ISO 8601.	29
`creditOffer.graceDays`	`integer`	Quantidade de dias para a carência do primeiro pagamento.	30
`creditOffer.lastPaymentDate`	`string`	Data do último pagamento da proposta.	292
`creditOffer.loanAmount`	`number`	Valor do crédito solicitado para contratação.	decimal (18,4)
`creditOffer.monthlyInterestRate`	`number`	Taxa de juros mensal da contratação.	decimal (18,4)
`creditOffer.operationCostAmount`	`number`	Custo de processamento da operação.	decimal (18,4)
`creditOffer.retentionRate`	`number`	Indica o percentual de retenção da proposta.	decimal (18,4)
`creditOffer.term`	`integer`	Quantidade de parcelas da proposta.	2
`creditOffer.totalInterestAmount`	`number`	Valor total de juros a ser pago na contratação.	decimal (18,4)
`creditOffer.totalPaymentAmount`	`number`	Valor total a ser pago no final do contrato (se aplicável ao produto).	decimal (18,4)
`creditOffer.iofTotalAmount`	`number`	Valor final do cálculo do IOF.	decimal (18,4)
`creditOffer.iofTotalPercentage`	`number`	Valor percentual do IOF, se aplicável.	decimal (18,4)
`creditOffer.confirmedOffer`	`boolean`	Informa se a oferta está confirmada.	—
`creditOffer.diaryIof`	`number`	Informa o percentual do IOF diário.	decimal (18,4)
`creditOffer.fixedIof`	`number`	Informa o percentual do IOF fixo.	decimal (18,4)
`creditOffer.Installments[]`	`array of objects`	Lista de objetos contendo os parcelamentos e suas informações.	—
`creditOffer.Installments[].creditOfferId`	`integer`	Identificador único da proposta.	20
`creditOffer.Installments[].amortizationAmount`	`number`	Valor da amortização no contrato.	decimal (18,4)
`creditOffer.Installments[].dueDate`	`string`	Data de vencimento da parcela.	29
`creditOffer.Installments[].interestAmount`	`number`	Valor dos juros da parcela.	decimal (18,4)
`creditOffer.Installments[].iofAmount`	`number`	Valor do IOF da parcela.	decimal (18,4)
`creditOffer.Installments[].paymentAmount`	`number`	Valor da parcela.	decimal (18,4)
`creditOffer.Installments[].installmentNumber`	`integer`	Nú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": "2022-10-25T19:10:11.564Z", 
      "externalCreatedAt": "2022-10-25T19:10:11.564Z", 
      "externalExpiresAt": "2022-10-25T19:10:11.564Z", 
      "firstPaymentDate": "2022-10-25T19:10:11.564Z", 
      "graceDays": 0, 
      "lastPaymentDate": "2022-10-25T19:10:11.564Z", 
      "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": "2022-10-25T19:10:11.564Z", 
          "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 Code	Código	Mensagem	Descrição
400	CONTRACT_IS_IN_CRELIQ	Contract from statment is Creliq status.	Contrato da declaração está em status Creliq.
406	STATEMENT_IS_NOT_CLOSED	Statement is not closed!	A fatura não está fechada.

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.

Pré-requisitos

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

✅Dica

Erros

Eventos

✅
Dica