Pular para o conteúdo principal
GET
Ler fatura no checkout

Parâmetros de caminho

slug
string
obrigatório

O identificador público da sua conta, o mesmo das URLs de checkout.

invoiceID
string
obrigatório

ID da fatura.

Pattern: ^inv_[0-9A-Za-z]{22}$
Exemplo:

"inv_6yi30EKotIwGHZdePSdsFc"

Resposta

A fatura e as opções de pagamento.

O que a página de checkout recebe para mostrar e cobrar uma fatura.

merchant
object
obrigatório

Nome e aparência da sua conta, como o pagador vê.

invoice
object
obrigatório

O que um cliente deve: itens, totais e status. Status: draft → open → paid, ou void / uncollectible.

testMode
boolean
obrigatório

true quando a fatura é do sandbox: nenhum dinheiro real se move.

paymentOptions
object[]
obrigatório

Os meios de pagamento disponíveis para esta fatura.

Um meio de pagamento que o checkout pode oferecer. É uma indicação: a disponibilidade é conferida de novo na cobrança.

cardEnabled
boolean
obrigatório

Se cartão está disponível. Derivado de paymentOptions; sempre presente.

acceptsPayments
boolean
obrigatório

Se a loja já recebe pagamentos neste caminho. false enquanto a conta de recebimento no provedor de pagamento não estiver pronta: paymentOptions vem vazio e o checkout avisa o pagador. Sempre presente.

purchase
object

A vendedora oficial em venda internacional. Em breve.

totals
object
autoTopupAvailable
boolean
withdrawalWaiver
object
unavailableReason
enum<string>
Opções disponíveis:
product_not_available,
buyer_country_required,
supplier_country_required,
supplier_country_conflict,
domestic_payments_unavailable,
collection_unavailable,
country_mismatch,
invoice_not_payable,
direct_collection_reconciliation_required
paymentMethod
enum<string>

Meio do pagamento confirmado. Só aparece depois que a fatura é paga.

Opções disponíveis:
pix,
card
mandate
object

Autorização para salvar o cartão, que o pagador precisa aceitar. Só aparece quando há cartão e a fatura está aberta. Envie version como consentTextVersion ao cobrar com saveInstrument.

remember
object