Skip to main content
GET
Read an invoice at checkout

Path Parameters

slug
string
required

Your account's public identifier, as in checkout URLs.

invoiceID
string<uuid>
required

Invoice ID.

Response

The invoice and payment options.

What the checkout page receives to show and charge an invoice.

merchant
object
required

Your account's name and look, as the payer sees them.

invoice
object
required

What a customer owes: line items, totals and status. Status: draft → open → paid, or void / uncollectible.

testMode
boolean
required

true when the invoice is in sandbox: no real money moves.

paymentOptions
object[]
required

The payment methods available for this invoice.

A payment method the checkout can offer. It is a hint: availability is checked again at charge time.

cardEnabled
boolean
required

Whether card is available. Derived from paymentOptions; always present.

cryptoEnabled
boolean
required

Whether crypto payment is available on this checkout.

paymentMethod
enum<string>

Method of the confirmed payment. Present only once the invoice is paid.

Available options:
pix,
boleto,
card,
crypto
mandate
object

Authorization to save the card, which the payer must accept. Present only when card is available and the invoice is open. Send version as consentTextVersion when charging with saveInstrument.