Visao Geral do Fluxo
Criando uma Cobrança PIX
Crie a transação
Envie um
POST /transactions com method: "PIX" e o valor em centavos.O header
Idempotency-Key e obrigatório e deve ser um UUID v4 único por tentativa de criacao. Reenviar a mesma chave retorna a resposta original sem criar uma nova transação.Exiba o QR Code para o comprador
A resposta Use
201 contém os dados PIX para exibição.Resposta 201
pix.qrcode para exibir a imagem do QR Code ou pix.copyPaste para o código Pix Copia e Cola. Exiba também o tempo de expiração para o comprador.Campos da Requisicao
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount | integer | Sim | Valor em centavos (ex: 15000 = R$ 150,00) |
method | string | Sim | Deve ser "PIX" |
description | string | Não | Descrição exibida no comprovante |
customer.name | string | Sim | Nome do comprador |
customer.email | string | Sim | Email do comprador |
customer.document | string | Sim | CPF (11 digitos) ou CNPJ (14 digitos) |
items | array | Não | Itens do pedido |
metadata | object | Não | Dados extras (ex: ID do pedido no seu sistema) |
Tratamento de Erros
| Status HTTP | Código de erro | Causa |
|---|---|---|
400 | INVALID_INPUT | Campos obrigatórios ausentes ou invalidos |
409 | IDEMPOTENCY_CONFLICT | Idempotency-Key ja foi usada — retorna transação original |
422 | FEE_EXCEEDS_AMOUNT | Taxa configurada e maior que o valor da transação |
503 | PROVIDER_UNAVAILABLE | Provedor indisponível no momento |
Verificando o Status Manualmente
Se precisar verificar o status de uma transação sem depender do webhook:O PIX tem crédito imediato na wallet. Diferente do boleto (D+3) e cartão (D+N dias úteis), o
netAmount fica disponível para saque assim que o status muda para PAID.Pontos de Atencao
- O QR Code PIX tem expiração padrão (geralmente 30-60 minutos). Exiba o tempo restante para o comprador.
- Transações expiradas recebem o evento
TRANSACTION_FAILED. - O
end2endIdno webhook identifica a transação de forma única no Sistema de Pagamentos Brasileiro (SPB) — use-o para conciliacao bancaria. - O campo
customerno webhook tem dados PII mascarados (LGPD). Para dados completos, consulteGET /transactions/:idautenticado.