Simulação de antecipação de parcelas

stable

Este endpoint permite que o cliente do parceiro Bankly simule a antecipação de parcelas de refinanciamento, registradas em ciclos de faturas futuros, ou seja, que ainda não foram fechados nem abertos. A simulação exibirá o valor atualizado da parcela e os possíveis descontos aplicados após a antecipação.

Pré-requisito

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

🚧

Importante

Não é possível simular a antecipação de itens parcelados que não sejam resultantes de um refinanciamento de fatura.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/item/{statementItemId}/installment-advance
--request GET
--url '<https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/item/{statementItemId}/installment-advance>' \\
--header 'Authorization: Bearer {{Token}}' \
--header 'api-version: 1.0' \
--header 'accept: application/json' \

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 os seguintes campos:

NomeTipoDescriçãoEspecificação
statementIdpathObrigatório. Identificador único da fatura em aberto.Insira somente números, sem caracteres especiais.
statementItemIdpathObrigatório. Identificador de uma das parcelas de refinanciamento elegíveis para antecipação.Insira somente números, sem caracteres especiais.

Corpo da requisição (Body)

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

Resposta (Response)

status code 200 indicará que a solicitação foi aceita com sucesso e retornará uma lista contendo todas as parcelas passíveis de serem antecipadas e suas informações.

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

NomeTipoDescriçãoNúmero máximo de caracteres
statementIdintegerIdentificador único da fatura em aberto, a qual receberá os valores das parcelas antecipadas.
statementItemIdintegerIdentificador da parcela de refinanciamento elegível para antecipação.
installmentNumberintegerNúmero da parcela.
paymentAmountnumberValor total da parcela.decimal(18,4)
interestAmountnumberValor dos encargos aplicados à parcela.decimal(18,4)
adjustedAmountnumberValor da parcela após a remoção dos encargos.decimal(18,4)
[
  {
    "statementId": 0,
    "statementItemId": 0,
    "installmentNumber": 0,
    "paymentAmount": 0,
    "interestAmount": 0,
    "adjustedAmount": 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
406INVALID_COMMANDInvalid commandO conteúdo da requisição não está de acordo com o esperado.
406STATEMENT_ITEMS_DATA_NOT_FOUNDStatement Items Data not found!Não foi encontrada nenhuma parcela (statementItemId) com o ID informado na requisição.
406INSTALLMENTS_ITEMS_DATA_NOT_FOUNDInstallments Items Data not found!O item de fatura não possui parcelas futuras.
406NOT ACCEPTABLENot AcceptableTentativa de antecipação de um item que não é de refinanciamento (REFINANCE_INSTALLMENT ou CP_REFINANCING_INSTALLMENT).

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.