correlationId que você escolheu na criação chega de volta no evento de webhook, amarrado àquele pagamento específico.
Quando usar
Checkout de e-commerce
Gere um QR Code por pedido no momento do checkout. Quando o webhook chegar com o
correlationId, você sabe exatamente qual pedido baixar, sem conciliação manual.Cobranças avulsas
Envie um link de pagamento por e-mail, WhatsApp ou SMS. O QR Code expira no prazo que você definir, evitando pagamentos tardios indesejados.
Passo a passo
Crie o QR Code Dinâmico
O mínimo necessário é o Para checkouts, você normalmente vai querer um prazo mais curto e já receber a imagem do QR Code pronta:
correlationId e o amount. Por padrão, o QR Code expira em 24 horas (86.400 segundos), mas você pode reduzir esse prazo com o campo expiresIn.Exiba o QR Code para o pagador
A resposta traz tudo que você precisa para apresentar a cobrança:
payloadPix, o código “Pix Copia e Cola”, para quem prefere colar manualmente no app do banco.qrCodeImageBase64, imagem pronta do QR Code, disponível quandoformatResponseéPAYLOAD_AND_QRCODE.expiresAt, o instante exato de expiração; use para exibir um contador regressivo na tela de checkout.
Receba a confirmação via Webhook
Quando o pagamento é liquidado, a API dispara o evento
PIX_RECEIVED para a URL de webhook que você configurou. Esse evento carrega o correlationId que você definiu na criação, use-o para identificar qual pedido foi pago e acionar a baixa no seu sistema.Veja Processando a confirmação via Webhook para o passo a passo completo de tratamento desse evento.Consulte o status quando necessário
A qualquer momento você pode buscar o estado de uma cobrança pelo Quando o pagamento já tiver sido realizado, a resposta inclui o array
correlationId ou pelo transactionId:cURL
payments com todos os detalhes da transação: endToEndId, dados do pagador real, valor e horário de liquidação.Funcionalidades avançadas
Restringir o pagamento a um pagador específico
Você pode vincular o QR Code a um CPF ou CNPJ específico. Compayer.validate: true, o código só será aceito quando o pagador que escanear for exatamente aquela pessoa.
Split de pagamento
Distribua parte do valor recebido para outra conta automaticamente no momento da criação. Útil para marketplaces e plataformas que precisam repassar comissões sem transferências manuais.type aceita PERCENTAGE (porcentagem do total) ou FIXED (valor fixo em reais).
O split só funciona se o
amount for maior que R$ 1,00, e o total das divisões não pode ultrapassar 50% do valor da cobrança.Beneficiário final (para gateways)
Se você opera como gateway ou subadquirente, usefinalBeneficiary para indicar o recebedor final da transação. Esse dado é exibido ao pagador no app do banco no momento do pagamento.
Referência da API
Criar
POST /pix/qrcode/dynamicConsultar
GET /pix/qrcode/dynamic/:idCancelar
PATCH /pix/qrcode/dynamic/:id/cancel
