Geração de uma forma de pagamento

post

https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/payment

Gere uma forma de pagamento para uma fatura específica, por meio do seu ID.

stable scope: invoice.write

[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]

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

statementId

int32

required

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

Body Params

paymentType

string

enum

required

Opção de pagamento.

Allowed:

amount

object

Objeto que deverá conter informações sobre o valor a ser pago. Importante: o envio deste objeto é obrigatório somente se o tipo de pagamento escolhido for “Partial”.

paymentOptionId

int32 | null

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

Headers

Authorization

string

required

Token de autorização do tipo Bearer.

api-version

string

required

Defaults to 1

Versão da API. Atualmente estamos na 1.0.

Idempotency-Key

string

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

x-correlation-id

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Solicitação aceita com sucesso.

400Há algum problema com a sua requisição.

406A solicitação não foi aceita.