Antecipação de parcelas

stable

A antecipação de parcelas visa permitir que o cliente realize o pagamento de uma parcela antes do prazo de vencimento estabelecido no contrato de crédito.

Atualmente, o Bankly permite apenas a antecipação de parcelas de refinanciamento (Parcelado ou Parcelado Compulsório).

👍

Dica

Para mais informações sobre antecipação de parcelas de refinanciamento, consulte a Visão geral desta documentação.

Portanto, este endpoint tem como finalidade gerar o adiantamento de parcelas referentes a um refinanciamento.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

• Possua uma fatura refinanciada, do tipo Parcelado ou Parcelado Compulsório.

🚧

Importante

Somente será possível gerar o adiantamento de parcelas cujo TransactionType apresente o valor REFINANCE_INSTALLMENT (Parcelado) ou CP_REFINANCING_INSTALLMENT (Parcelado Compulsório).

Requisição

Requisição HTTP

HTTP

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

cURL

curl --request POST \ 
      --url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/item/{statementItemId}/advancement' \ 
      --header 'Authorization: Bearer {Token}'\ 
      --header 'accept: text/plain' \ 
      --header 'api-version: 1.0' \ 
      --header 'content-type: application/json'
      --data-raw '
      {
        "installmentAdvanceQuantity": 0,
        "removeInterest": true
      }'

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.write	Concede acesso para gerar uma forma de pagamento ou antecipar parcelas de uma fatura.

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 em aberto.
statementItemId	path	Obrigatório. Identificador de uma das parcelas de refinanciamento passíveis de serem antecipadas.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
installmentAdvanceQuantity	number	Obrigatório. Quantidade de parcelas de refinanciamento a serem antecipadas.
removeInterest	boolean	Obrigatório. Sinaliza se os encargos das parcelas devem ser removidos (TRUE) ou não (FALSE). Como se trata de parcelas de refinanciamento, preencha este campo com TRUE.

JSON

 {
  "installmentAdvanceQuantity": 2,
  "removeInterest": true
}

Resposta (Response)

O status code 202 indicará que a antecipação foi processada com sucesso.

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

Nome	Tipo	Descrição
statementId	integer	Identificador único da fatura em aberto.
statementItemsId	array of integer	Lista que contém os IDs das parcelas de refinanciamento antecipadas.

JSON

{
  "statementId": 2,
  "statementItemsId": [
    3,
    4
  ]
} 

👍

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
406	STATEMENT_IS_NOT_CLOSED	Statement is not closed!	A fatura não está fechada.
406	STATEMENT_ITEMS_DATA_NOT_FOUND	Statement Items Data not found!	Os itens de fatura não foram encontrados.
406	Not Acceptable	Not Acceptable	Tentativa de antecipação de um item que não é de refinanciamento (REFINANCE_INSTALLMENT ou CP_REFINANCING_INSTALLMENT).
406	INVALID_COMMAND	Invalid command	Comando inválido.

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.