Pagamento de faturas

Baixa de fatura por meio de pagamentos externos

<div class="bkly-ref-description"> <p>Realize a baixa total ou parcial de uma fatura emitida por meio de seu próprio sistema financeiro.</p> <span class="bkly-ref-small-beta-tag">beta</span> <span class="bkly-ref-scope-tag">scope: invoice.write</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Baixa de fatura por meio de pagamentos externos](/docs/baixa-de-fatura)." } [/block]

post/cards/invoices/{statementId}/settlement

Request

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

Path parameters

statementIdinteger required

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

Headers

Idempotency-Keystring required

Chave de idempotêcia para a requisição (UUID v4).

x-correlation-idSchema required(unresolved $ref)

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Parameters

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

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

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

Request body

type'Pix' | 'Billet' required

Meio pelo qual a fatura será liquidada.

liquidateDatestring date-time required

Data de liquidação do pagamento, que não pode ser superior a seis dias da data do pagamento.

paymentDatestring date-time required

Data do pagamento.

externalIdstring required

Identificador único da fatura que está sendo paga.

paymentOptionIdinteger

Identificador único da opção de pagamento. O valor deste campo é obtido por meio do <i>endpoint</i> de Consulta de opções de pagamento.

Response

A requisição foi aceita e está sendo processada.

Changes

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