Antecipação de parcelas

Confirmação de antecipação de parcelas

<div class="bkly-ref-description"> <p>Realize o adiantamento de parcelas referentes a um refinanciamento (parcelado ou parcelado compulsório) e/ou de compras realizadas no cartão.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: invoice.write</span> </div> [block:callout] { "type": "warning", "title": "Importante", "body": "Somente será possível gerar o adiantamento de parcelas cujo <code>transactionType</code> apresente o valor <code>REFINANCE_INSTALLMENT</code>, <code>CP_REFINANCING_INSTALLMENT</code> ou ou <code>INSTALLMENT_WITHOUT_INTEREST</code>. Confira a documentação [Antecipação de parcelas](/docs/antecipacao-de-parcelas) para mais informações." } [/block]
post/cards/invoices/{statementId}/item/{statementItemId}/advancement

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/item/{statementItemId}/advancement
  • Auth
    HTTP bearer

Path parameters

statementIdinteger required

Identificador único da fatura em aberto. Insira somente números, sem caracteres especiais.

statementItemIdinteger required

Identificador de uma das parcelas de refinanciamento ou de uma compra que podem ser antecipadas.

Parameters

#/paths/~1cards~1invoices~1adjustments/post/parameters/0 (unresolved $ref)
#/paths/~1cards~1invoices~1adjustments/post/parameters/1 (unresolved $ref)

Request body

installmentAdvanceQuantityinteger required

Quantidade de parcelas de refinanciamento ou de uma compra a serem antecipadas.

removeInterestboolean required

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 <b>TRUE</b>.

Response

Solicitação aceita com sucesso.

statementIdinteger

Identificador único da fatura.

statementItemsIdinteger[]

Lista que contém os IDs das parcelas de refinanciamento ou de uma compra antecipadas.

Changes

No recorded changes to this operation across all 1 revision of this API.