For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Gerar QR Code PIX Dinâmico

Cria um QR Code PIX do tipo dinâmico, vinculado a uma cobrança única, com identificação do pagador e metadados descritivos.

Este endpoint gera um QR Code PIX dinâmico, ou seja, um código único associado a uma transação específica.

Diferente do QR Code estático, o QR Code dinâmico contém um identificador exclusivo (txId) e pode incluir informações adicionais, como dados do pagador e metadados descritivos (ex.: produto, serviço, fatura, etc.).

O corpo da requisição deve conter:

  • key: valor ou identificador da chave PIX associada à conta;

  • amount: valor a ser cobrado (em reais, com até duas casas decimais);

  • payer: informações do pagador, contendo document e name;

  • description: lista de objetos com nome e valor, permitindo detalhar o pagamento.

O retorno inclui:

  • qrCode.image → imagem do QR Code em base64;

  • qrCode.text → conteúdo EMV completo do QR Code;

  • invoice.url → link do comprovante ou fatura associada à cobrança.

Endpoint para Criar Qr Code Dinâmico

POST /accounts/{accountId}/pix/qrcode/dynamic

Este endpoint é protegido e requer o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

x-tenant-id

Tenant ID

Body

Name
Type
Description

key

string

Chave para qual o QR Code será atrelado

amount

number

Valor

payer

object{document: string, name: string}

Descrição (opcional)

payer.document

string

CPF/CNPJ

payer.name

string

Nome

description

Array<{name: string,value: string}>

Descrição

Response

Last updated