Gerar QR Code Pix

API GeneratePixQRCode

A API da OWL Digital permite gerar cobranças via PIX com retorno do código “copia e cola” e pode ser usada para gerar o QR Code para leitura em aplicativos bancários. Esse tipo de cobrança é ideal para pagamentos instantâneos, com possibilidade de integrar à sua página de checkout, enviar por e-mail ou gerar em PDF.

📘

Importante

⚠️ Esse endpoint gera apenas cobrança via PIX. Para cobranças combinadas (PIX + Boleto), consulte Cobrança Híbrida

Exemplo de uso em uma interface

Basta exibir o hash para ser pago via "copia e cola". Para exibir o código gráfico, basta converter o hash e exibir na tela.

✅ Exemplo de uma cobrança

Exemplo: Gerar uma cobrança de R$ 550,00 com expiração até 31/12/2026, ou seja, o cliente tem até essa data para pagar.

Solução: Gerar o QR Code com changeType = 1 e o valor fixo. O resultado pode ser exibido em tela ou enviado como PDF, com o QR Code e o código de pagamento.

Requisição

{
  "clientid": 0,
  "pixKey": "string",
  "payerTaxId": "string",
  "payerName": "string",
  "value": 0,
  "changeType": 0,
  "expirationDate": "2025-06-24T11:34:43.769Z"
}

🔧 Campos da Requisição

CampoTipoObrigatórioDescrição
clientidintegerSimIdentificador do cliente
pixKeystringSimChave Pix do recebedor (e-mail, CPF, CNPJ ou aleatória).
payerTaxIdstringNãoCPF ou CNPJ do pagador.
payerNamestringNãoNome do pagador.
valuedecimalSimValor da cobrança em reais.
changeTypeintegerSimDefine se o valor é fixo (1) ou aberto (0).
expirationDatedatetimeSimData/hora de validade do QR Code.

Resposta

{
    "success": true,
    "data": {
        "collectionId": 41,
        "hashCode": "00020101021226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br/QR/cob/513F5C6C44BD60FF24C554495C99CB07DFC5204000053039865802BR5915Artur Carvalho6009Fortaleza610806018122562070503***630412B1"
    },
    "message": null
}

📘

Importante!

  • O campo changeType define o comportamento do valor:
    • 1Valor fixo. Ideal para mensalidades, produtos ou faturas.
    • 0Valor aberto. O pagador escolhe quanto pagar. Útil para doações, ofertas, etc.
  • Os campos payerTaxId e payerName são opcionais e utilizados para identificação, porém, é RECOMENDADO que sejam informados.
    • Se um desses dois campos for informado (payerTaxId ou payerName), o outro torna-se automaticamente obrigatório.
  • Este tipo de QrCode não permite que o cliente emita cobranças com valor 0, portanto as cobranças geradas devem ter um Value maior ou igual a 0.01