Confirmação de antecipação de parcelas

stable

Este endpoint permite que o cliente do parceiro Bankly gere o adiantamento de parcelas referentes a um refinanciamento e/ou a compras realizadas no cartão.

👍

Dica

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


Pré-requisitos

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;
  • Possua uma fatura com compras parceladas.

🚧

Importante

Somente será possível gerar o adiantamento de parcelas cujo TransactionType apresente o valor REFINANCE_INSTALLMENT (parcelado), CP_REFINANCING_INSTALLMENT (parcelado compulsório) ou INSTALLMENT_WITHOUT_INTEREST (compra parcelada sem Juros).

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/item/{statementItemId}/advancement \ 
--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:

ScopeDescrição
invoice.writeConcede acesso para gerar uma forma de pagamento ou antecipar parcelas de uma fatura.

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 em aberto.
statementItemIdpathObrigatório. Identificador de uma das parcelas de refinanciamento ou de uma compra que podem ser antecipadas.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescrição
installmentAdvanceQuantitynumberObrigatório. Quantidade de parcelas de refinanciamento ou de uma compra a serem antecipadas.
removeInterestbooleanObrigatório. Sinaliza se os encargos das parcelas devem ser removidos (TRUE) ou não (FALSE). Como se trata de parcelas de refinanciamento ou de uma compra, preencha este campo com TRUE.
 {
  "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:

NomeTipoDescrição
statementIdintegerIdentificador único da fatura em aberto.
statementItemsIdarray of integerLista que contém os IDs das parcelas de refinanciamento ou de uma compra antecipadas.
{
  "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 CodeCódigoMensagemDescrição
406STATEMENT_IS_NOT_CLOSEDStatement is not closed!A fatura não está fechada.
406STATEMENT_ITEMS_DATA_NOT_FOUNDStatement Items Data not found!Os itens de fatura não foram encontrados.
406Not AcceptableNot AcceptableTentativa de antecipação de um item que não é de refinanciamento (REFINANCE_INSTALLMENT ou CP_REFINANCING_INSTALLMENT) ou de compra parcelada sem juros (INSTALLMENT_WITHOUT_INTEREST).
406INVALID_COMMANDInvalid commandComando 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.