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

{
  "qrCodes": [
    {
      "txId": "tx093f8c5a2e4b97d1",
      "amount": 49.90,
      "status": "PENDING",
      "amountPaid": null,
      "expiresAt": "2025-11-01T23:59:59.000Z",
      "payerName": "Juliana Santos Almeida",
      "payerDocument": "98765432100",
      "invoice": {
        "url": "https://global.stric.com.br/invoices/invoice-1a2b3c4d5e6f.pdf"
      }
    },
    {
      "txId": "tx98f7b1c6d4a3e2f0",
      "amount": 120.75,
      "status": "PAID",
      "amountPaid": 120.75,
      "expiresAt": null,
      "payerName": null,
      "payerDocument": null,
      "invoice": {
        "url": "https://global.stric.com.br/invoices/invoice-7f8e9d6c5b4a.pdf"
      }
    },
    {
      "txId": "tx8a1c2b3d4e5f6a7b",
      "amount": 15.00,
      "status": "EXPIRED",
      "amountPaid": null,
      "expiresAt": "2025-10-05T00:00:00.000Z",
      "payerName": null,
      "payerDocument": null,
      "invoice": {
        "url": "https://global.stric.com.br/invoices/invoice-0d9e8f7a6b5c.pdf"
      }
    }
  ],
  "pagination": {
    "total": 3,
    "page": 0,
    "limit": 20,
    "totalPages": 1,
    "hasNextPage": false
  }
}

Last updated

Was this helpful?