For the complete documentation index, see llms.txt. This page is also available as Markdown.

Listar QR Codes PIX Dinâmicos

Retorna todas as cobranças PIX do tipo dinâmico geradas para uma conta bancária, com suporte a filtros e paginação.

Este endpoint permite consultar e listar QR Codes dinâmicos (cobranças PIX) associados a uma conta específica.

É possível aplicar filtros para refinar os resultados, como status da cobrança, nome ou documento do pagador, e também realizar paginação dos resultados.

Cada registro retornado contém informações detalhadas sobre o QR Code, incluindo o valor, status da cobrança, dados do pagador, data de criação e link do PDF da fatura.

🔍 Filtros Disponíveis

status

string

Filtro pelo status do QR Code. Valores possíveis: PENDING, PAID, DONE, CANCELED, EXPIRED

payerName

string

Filtra cobranças pelo nome do pagador.

payerDocument

string

Filtra cobranças pelo CPF/CNPJ do pagador.

page

string

Número da página (para paginação).

limit

string

Quantidade de itens por página (para paginação).

Endpoint para Listar Qr Codes Dinâmicos

GET /accounts/{accountId}/pix/qrcode

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

Response

Last updated

Was this helpful?