Skip to main content
POST
Pagar 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<uuid>
obrigatório

ID da fatura.

Corpo

application/json

O meio escolhido pelo pagador. method ausente ou fora da lista responde 422.

method
enum<string>
obrigatório

Meio de pagamento.

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

Dados do cartão. Obrigatório quando method é card num checkout embutido.

saveInstrument
boolean

O pagador escolheu salvar o cartão para cobranças automáticas futuras. Exige consentTextVersion; sem ele, responde 422.

A versão do texto de autorização que o pagador viu: repita CheckoutSession.mandate.version. Obrigatório com saveInstrument.

surface
enum<string>
padrão:hosted

Qual checkout da Infi o pagador está usando. Define para onde o navegador volta depois de uma verificação do banco. Use embed num checkout embutido (iframe); sem o campo, vale hosted, e o pagador sai do iframe para a página completa.

Opções disponíveis:
hosted,
embed

Resposta

A cobrança criada.

Uma tentativa de cobrança contra uma fatura. Uma fatura pode ter vários pagamentos.

id
string<uuid>
invoiceId
string<uuid>
provider
string

Processador por onde a cobrança passou. Em sandbox, sandbox.

providerId
string | null

Referência da cobrança no processador, útil para suporte.

method
enum<string>
Opções disponíveis:
pix,
boleto,
card,
crypto
amount
string

Valor cobrado, em texto decimal.

currency
string
status
enum<string>

pending aguarda pagamento; confirmed foi pago; failed não foi pago (veja failureCode); refunded foi reembolsado por inteiro; charged_back foi contestado pelo comprador no banco.

Opções disponíveis:
pending,
confirmed,
failed,
refunded,
charged_back
refundedAmount
string

Total já reembolsado, em texto decimal. Ausente quando nada foi reembolsado. Um reembolso parcial mantém o status em confirmed; só o reembolso do valor inteiro muda para refunded. Use este campo, e não o status, para saber quanto voltou.

failureCode
enum<string> | null

Por que a cobrança falhou. superseded não é recusa: o comprador trocou de meio de pagamento para pagar a mesma fatura. Nulo quando o pagamento não falhou ou quando o motivo não foi registrado. Novos códigos podem surgir; trate um valor desconhecido como falha genérica.

Opções disponíveis:
insufficient_funds,
do_not_honor,
card_declined,
authentication_required,
card_expired,
card_stolen,
card_invalid,
mandate_revoked,
mandate_refused,
brand_changed,
provider_error,
provider_timeout,
superseded,
null
failedAt
string<date-time> | null

Quando a cobrança passou para failed.

createdAt
string<date-time>
payer
object | null

Quem pagou. Em fatura avulsa, id é o ID do cliente; em fatura de assinatura, é o ID da inscrição do cliente no produto. Vem só em GET /billing/payments e GET /billing/payments/{paymentID}, e é nulo quando a fatura não identifica o cliente.

invoiceUrl
string

Página de pagamento hospedada. Vem só na resposta da criação da cobrança.

chargeToken
string

Token de uso único do widget de pagamento cripto. Vem só na resposta de uma cobrança cripto.

network
enum<string>

Ambiente do widget cripto desta cobrança: main (real) ou test.

Opções disponíveis:
main,
test
settlementAsset
enum<string>

Ativo em que a cobrança cripto é liquidada.

Opções disponíveis:
USDC
settlementNetwork
enum<string>

Rede em que a cobrança cripto é liquidada.

Opções disponíveis:
base,
solana
pixPayload
string

Código Pix copia e cola. Gere o QR a partir dele. Continua disponível nas consultas seguintes do pagamento.

pixQrImage
string

O QR do Pix em PNG, codificado em base64 (sem o prefixo data:), para quem prefere não gerar o QR.

providerPixPayload
string

Só em sandbox: o código Pix que o processador de teste gerou, para inspeção. Não é pagável. Em sandbox, pixPayload traz o link de confirmação de teste.

sandboxConfirmUrl
string

Só em sandbox: página que marca esta cobrança como paga, sem pagar de verdade. Decida pela presença deste campo, não pelo formato de pixPayload. Para exibir, não é preciso: pixPayload vira QR nos dois ambientes.

pixExpiresAt
string<date-time> | null

Quando o código Pix expira (só cobranças Pix).

clientSecret
string

Segredo temporário para confirmar a cobrança de cartão no navegador. Vem só na resposta da criação da cobrança.

publishableKey
string

Chave pública que acompanha clientSecret. Vem só na resposta da criação da cobrança.

nextAction
object

Dados para concluir uma cobrança de cartão no navegador. Vem só na resposta da criação da cobrança.

switchable
boolean

Se esta cobrança ainda pode ser abandonada para pagar a mesma fatura de outro jeito: true enquanto está pending, false depois de paga ou falhada. Vem só na resposta da criação da cobrança; trate ausência como false.