Invoices - Generate payment method

Generates a PIX QR Code or Boleto for paying a specific invoice. The payment method is generated on demand and has an expiration time.

PIX: Returns a QR Code (string, base64 image, and copy-paste code) for instant payment. Boleto: Returns barcode, digitable line, and a PDF download URL.

The amount in the response already incorporates any applicable charges (fines + interest if overdue) or early payment discount (if paying before the due date). Use discount_amount to see the discount applied. Pass skip_discount: true to suppress the discount and receive the full face value instead.

Partial payment: Optionally pass installment_ids to pay only specific installments instead of the full invoice. When provided, the generated payment method will cover only the selected installments. If omitted, the payment covers the entire invoice balance.

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

Invoice identifier

Body Params

Request to generate a payment method (PIX or Boleto) for an invoice.

string
enum
required

Payment method to generate

Show Details
PIXInstant payment via PIX. Returns QR Code and copy-paste code.
BOLETOBank payment slip (Boleto Bancário). Returns barcode, digitable line, and PDF URL.
Allowed:
installment_ids
array of strings

Optional list of specific installment IDs to pay. When omitted, the payment covers the entire invoice balance.

installment_ids
string

Partner-provided reference ID for this payment, used for reconciliation

boolean
Defaults to false

When true, suppresses early payment discount calculation. The amount returned will be the full face value regardless of how many days remain until the due date. Default: false.

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