Listar QRCodes

Permite obter uma lista de cobranças geradas atribuindo diversos filtros para selecionar os itens desejados. A resposta vem em formato paginado, sendo no máximo 100 registros por página. Um atributo meta será retornado informando os parâmetros totalizadores e o total de páginas da consulta realizada.

Fazendo Requisição

A chamada deverá ser feita utilizando o método GET.

GET/v1/pix/qrcodes

URL Params – Filter Options

PARÂMETRO	DESCRIÇÃO	TIPO
page (Opcional)	Número da página. Se não informado, assume o valor 1	INTEGER maior que 0
registration_start_date (Obrigatório caso registration_end_date seja informado)	Valor inicial para o período de busca por data de geração das cobranças	STRING formato datetime YYYY-mm-ddTHH:MM:ss
registration_end_date (Obrigatório caso registration_start_date seja informado)	Valor final para o período de busca por data geração das cobranças	STRING formato datetime YYYY-mm-ddTHH:MM:ss
payment_start_date (Obrigatório caso payment_end_date seja informado)	Valor inicial para o período de busca por data de pagamento das cobranças	STRING formato datetime YYYY-mm-ddTHH:MM:ss
payment_end_date (Obrigatório caso payment_start_date seja informado)	Valor final para o período de busca por data pagamento das cobranças	STRING formato datetime YYYY-mm-ddTHH:MM:ss
generator_name (Opcional)	Nome do gerador das cobranças. Consulta do tipo LIKE	STRING limite 100 caracteres
generator_document (Opcional)	CPF/CNPJ do gerador das cobranças. Consulta do tipo LIKE	STRING limite 14 caracteres apenas números
payer_name (Opcional)	Nome do pagador das cobranças. Consulta do tipo LIKE	STRING limite 100 caracteres
payer_document (Opcional)	CPF/CNPJ do pagador das cobranças. Consulta do tipo LIKE	STRING limite 14 caracteres apenas números
status (Opcional)	Status das cobranças	STRING (Enum) error (Erro ao gerar cobrança) awaiting_payment (Aguardando Pagamento) paid (Pago) canceled (Cancelado)
reference_code (Opcional)	Código de identificação. Consulta do tipo LIKE	STRING limite 100 caracteres
end_to_end (Opcional)	Código de pagamento. Consulta do tipo LIKE	STRING limite 32 caracteres

Sucesso

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

{
    "qrcodes": [
        {
            "reference_code": "ZENDRYTESTPIXQRCODE1",
            "external_reference": null,
            "value_cents": 1,
            "content": "00000000000000000000br.gov.bcb.pix012345678900-1234-1234-1234-12345678901234567890123456789000.012345BR5925Zendry Solucoes em Paga6009SAO PAULO62230519ZendryPIXQRCODETESTE00000",
            "status": "awaiting_payment",
            "generator_name": null,
            "generator_document": null,
            "payer_name": null,
            "payer_document": null,
            "registration_date": "2024-04-02T14:24:36.000-03:00",
            "payment_date": "2024-04-02T14:24:36.000-03:00",
            "end_to_end": null,
            "platform_name": null,
            "billing_url": null,
            "return_url": null,
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_items_amount": 6,
        "total_value_cents": 50004
    }
}

Descrição dos Atributos

PARÂMETRO	DESCRIÇÃO	TIPO
qrcodes (Obrigatório)	Lista de cobranças qrcodes que obedecem os filtros especificados	ARRAY
qrcodes.reference_code (Obrigatório)	Identificador único do QRCode.	STRING limite de 100 caracteres
qrcode.external_reference (Opcional)	Valor informado pelo parceiro como identificação do qrcode gerado.	STRING limite de 255 caracteres
qrcodes.value_cents (Obrigatório)	Valor da cobrança, em centavos	INTEGER Maior que 0
qrcodes.content (Obrigatório)	Conteúdo do QRCode. (Código copia e cola Pix)	STRING limite de 255 caracteres
qrcodes.status (Obrigatório)	Status da cobrança	ENUM error (Erro ao gerar cobrança) awaiting_payment(Aguardando Pagamento) paid (Pago) canceled (Cancelado)
qrcodes.generator_name (Opcional)	Nome do pagador	STRING limite de 100 caracteres
qrcodes.generator_document (Opcional)	Documento do gerador	STRING limite de 14 caracteres
qrcodes.payer_name (Opcional)	Nome do pagador	STRING limite de 100 caracteres
qrcodes.payer_document (Opcional)	Documento do pagador	STRING limite de 14 caracteres
qrcodes.registration_date (Obrigatório)	Data de criação da cobrança	STRING formato datetime YYYY-mm-ddTHH:MM:ss.z
qrcodes.payment_date (Opcional)	Data de pagamento da cobrança	STRING formato datetime YYYY-mm-ddTHH:MM:s s.z
qrcodes.end_to_end (Opcional)	Identificador único do pagamento Pix	STRING limite de 32 caracteres
qrcodes.platform_name (Opcional)	Nome da plataforma que está gerando o pagamento	STRING limite de 100 caracteres
qrcodes.billing_url (Opcional)	URL para redirecionar o usuário para a página customizada de cobrança	STRING limite de 255 caracteres
qrcodes.return_url (Opcional)	URL do webhook onde as notificações serão enviadas	STRING limite de 255 caracteres
meta (Obrigatório)	Objeto que contém os metadados da requisição	OBJECT
meta.current_page (Obrigatório)	Página atual da consulta	INTEGER maior que 0
meta.total_pages (Obrigatório)	Total de pßáginas da consulta realizada	INTEGER maior que 0
meta.total_items_amount (Obrigatório)	Quantidade total de cobranças existentes considerando todas as páginas	INTEGER maior que 0
meta.total_value_cents (Obrigatório)	Valor total, em centavos das cobranças considerando todas as páginas	INTEGER maior que 0

Erros

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 400 Response Body - Exemplo

{
  "error": "registration_end_date required"
}

HTTP 500 Response Body - Exemplo

  {
    "error": "Operation failed! Please try again or contact our support team"
  }