S
Stater

PIX entrada

QR code de depósito

Gere cobranças PIX via QR. O corpo é uma união discriminada pelo campo variant: simple, debtor ou cobv.

Criar cobrança

POST/v1/accounts/:accountId/pix/deposit-qrcodes

Escopo: pix:in. Valores monetários em centavos.

Campos comuns
variantenumrequired

simple | debtor | cobv

amountintegerrequired

Valor em centavos.

base64Imagebooleanoptionaldefault: true (simple), false (debtor)

Quando true, devolve PNG em base64.

Variante debtor

debtorNamestringrequired

Nome do pagador.

debtorDocumentstringrequired

CPF ou CNPJ (somente dígitos).

typeDocumentenumrequired

CPF | CNPJ

Variante cobv

dueDateISO 8601required

Data de vencimento.

expirationDateISO 8601required

Quando o QR expira.

fineDateISO 8601required

Data a partir da qual incide multa.

typeFineenumoptionaldefault: NONE

NONE | VALUE | PERCENT

finenumberoptional

Valor ou percentual de multa. Deve ser > 0 quando typeFine ≠ NONE.

tagstringoptional

Texto livre (ex.: número do pedido).

Imagem em base64

Quando base64Image: true, a resposta inclui imageBase64 com a imagem do QR code em PNG codificada em base64.

Erros

400 invalid_request — corpo inválido.

422 deposit_qr_failed — provedor recusou + reason.

422 account_not_virtual / account_missing_provider_fields / missing_env_or_account_config.

Consultar cobrança

GET/v1/accounts/:accountId/pix/charges/:chargeId

Escopo: pix:in. Mesmo formato resumido (sem depositSnapshot na API pública).

404 not_found quando o ID não existe ou pertence a outra conta.