Pagamento de faturas

Geração de uma forma de pagamento

<div class="bkly-ref-description"> <p>Gere uma forma de pagamento para uma fatura específica, por meio do seu ID.</p> <span class="bkly-ref-small-stable-tag">stable</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 [Geração de uma forma de pagamento](/docs/geracao-forma-pagamento)." } [/block]
post/cards/invoices/{statementId}/payment

Request

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

Path parameters

statementIdinteger required

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

Headers

x-correlation-idstring

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/4 (unresolved $ref)

Request body

paymentType'Cash' | 'Partial' | 'InstallmentWithEntry' | 'InstallmentWithoutEntry' required

Opção de pagamento.

paymentOptionIdinteger nullable

Identificador da opção de pagamento. Este campo é obrigatório somente se o tipo de pagamento escolhido tenha sido <code>InstallmentWithEntry</code>.

Response

Solicitação aceita com sucesso.

status'Pending' | 'Paid'

Situação do pagamento.

digitableLinestring nullable

Linha digitável do boleto de pagamento.

authenticationCodestring nullable

Identificador da forma de pagamento.

Changes

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