Faturas - Gerar método de pagamento

Gera um QR Code PIX ou Boleto para pagamento de uma fatura específica. O método de pagamento é gerado sob demanda e possui prazo de validade.

PIX: Retorna um QR Code (string, imagem base64 e código copia e cola) para pagamento instantâneo. Boleto: Retorna código de barras, linha digitável e URL de download do PDF.

O valor inclui multas e juros aplicáveis (se em atraso) ou descontos (se pagamento antecipado).

Pagamento parcial: Opcionalmente envie installment_ids para pagar apenas parcelas específicas em vez do valor total da fatura. Quando informado, o método de pagamento gerado cobrirá apenas as parcelas selecionadas. Se omitido, o pagamento cobre o saldo total da fatura.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identificador da fatura

Body Params
string
enum
required

Método de pagamento desejado

Show Details
PIXPagamento instantâneo via PIX. Retorna QR Code e código copia e cola.
BOLETOBoleto bancário. Retorna código de barras, linha digitável e URL do PDF.
Allowed:
installment_ids
array of strings

Lista opcional de identificadores de parcelas a pagar. Quando informado, apenas as parcelas especificadas serão incluídas no pagamento. Se omitido, o pagamento cobre o saldo total da fatura.

installment_ids
string

Identificador de pagamento do parceiro para reconciliação

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json