Skip to main content
POST
Criar Transação
Cria uma nova transação de pagamento PIX. O header Idempotency-Key é obrigatório e garante que retries não criem transações duplicadas. A resposta inclui o QR Code (imagem em base64) e o código Copia e Cola.
No momento, o único método de pagamento disponível é PIX.
A resposta vem encapsulada no envelope {status, data}: status é true em caso de sucesso e o objeto da transação fica em data. Acesse os campos via data.* (ex.: data.pix.copyPaste).
string
required
Sua API Key (sk_live_...). Veja Autenticacao.
string
required
Chave única para esta requisição (UUID v4 recomendado, max 128 chars). Retries com a mesma chave retornam a resposta original sem criar duplicatas. Armazenada por 24 horas.Exemplo: 550e8400-e29b-41d4-a716-446655440000
integer
required
Valor total da transação em centavos. Mínimo: 100 (R$ 1,00). Máximo: 100000000 (R$ 1.000.000,00).Exemplos: R$ 150,00 = 15000 | R$ 10,00 = 1000
string
Método de pagamento. Valor aceito atualmente: PIX. Se omitido, assume PIX por padrão.
object
required
Dados do comprador.
array
required
Lista de itens da transação. Mínimo 1 item. A soma de amount de todos os itens deve corresponder exatamente ao amount total.
string
Identificador seu para correlação e rastreamento. Ecoado no header X-Correlation-ID da resposta quando enviado.
string
Identificador do provedor de pagamento. Normalmente omitido — o servidor deriva automaticamente da configuração ativa da sua conta.
string
Referência do pedido no seu sistema.
string
URL HTTPS para notificações de mudança de status. Deprecado em favor de webhooks — prefira configurar um webhook.
object
Objeto JSON livre para dados do seu sistema (ex: ID do pedido).Exemplo: {"pedidoId": "ORD-2024-001", "canal": "app"}
string
Data/hora de expiração da transação (ISO 8601). Se omitido, usa o padrão da conta (1 hora para PIX).

Resposta

A resposta vem no envelope {status, data} — o objeto da transação fica em data.
string
Identificador único da transação.
string
Status inicial da transação: PENDING.
Novos valores podem ser adicionados a este campo. Trate valores desconhecidos como fallback. Não faça switch exaustivo.
integer
Valor em centavos.
string
Método de pagamento: PIX.
string
Data/hora de criação (ISO 8601).
object
Dados do comprador. customer.document vem redigido (só primeiros e últimos 2 dígitos visíveis).
object
Presente quando a transação é PIX.
string
QR Code em base64 (data:image/png;base64,...).
string
Código Copia e Cola PIX (EMV payload).
string
Data/hora de expiração do QR Code (ISO 8601).
string
Referência interna do provedor de pagamento (útil para suporte).

Erros

Erros de validação/negócio deste endpoint usam um envelope diferente do restante da API — veja a nota em Erros.

Exemplo de resposta