Gerar QRCode
POST
/pix/generateQrCode
A rota permite gerar um QR Code de pagamento informando o valor da cobrança, a data de expiração e, opcionalmente, se o pagamento deverá ser comunicado através de um webhook.A API recebe os dados necessários para criar uma cobrança através de QR Code e retorna os identificadores e informações necessárias para disponibilizar o pagamento ao cliente. O campo O campo O campo
Ativa a comunicação através do webhook de pagamento.
Não utiliza o webhook de pagamento para essa cobrança. Após a criação do QR Code, a API retorna:
🔳 Geração do QR Code
💰 Valor
amount representa o valor da cobrança em reais.Exemplo:
10.00 representa R$ 10,00.⏳ Expiração
expirationDate define a data e horário em que o QR Code deixará de ser válido para pagamento.⚠️ Após a data de expiração, o QR Code não deverá mais ser utilizado para realizar o pagamento.
🔔 Payment Webhook
paymentWebhook define se a API deverá utilizar o webhook de pagamento para comunicar a confirmação da transação.true
false
🔔 O webhook permite que o sistema receba automaticamente a atualização referente ao pagamento da cobrança.
✅ Resultado
qrCodeId → Identificador único do QR Code.textQrCode → Texto do QR Code utilizado para realizar o pagamento.qrCodeNumber → Número identificador da cobrança.✅ Com essas informações, o sistema pode disponibilizar o QR Code ao cliente e acompanhar a cobrança através do identificador retornado.
📌 Regras
amountdefine o valor da cobrança em reais.expirationDatedefine a data e horário de expiração do QR Code.paymentWebhook: truehabilita a comunicação do pagamento através do webhook.paymentWebhook: falsedesabilita o webhook para essa cobrança.qrCodeIdidentifica unicamente o QR Code gerado.textQrCodecontém o texto utilizado para o pagamento.qrCodeNumberidentifica numericamente a cobrança.- Após a expiração, o QR Code não deverá mais ser utilizado para pagamento.
Requisição
Parâmetros Bodyapplication/jsonNecessário
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/pix/generateQrCode' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 10.00,
"expirationDate": "date",
"webhook": true
}'Response Response Example
{
"id": 000000000,
"number": "00000000-0000-0000-0000-000000000000",
"text": "Texto QRCode"
}Modificado em 2026-09-03 18:37:23