API Reference

Listar Pix

Retorna os pixes gerados.

Log in to see full request history

Listar Pix por Grupo/Estabelecimento

Retorna os dados de todos os pixes gerados através de um grupo/estabelecimento, podendo ser filtrado por, cpf ou cnpj, status, captura, terminal e data.

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization".

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{ "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0" }
Path Params
string
required

Id do grupo. Ex.: 123

Query Params
string

Cpf ou Cnpj do estabelecimento. Ex.: 12312312312

string

Status do pix. Ex.: ATIVA, EXPIRADO ou CONCLUIDA

string

Captura do pix. Ex.: NAO IDENTIFICADO, E-COMMERCE, RECORRENCIA PIX, PIX PORTAL CLIENTE, PIX API ou PIX APP.

string

Terminal do pix. Ex.: BRWPabcdef123456

string

Data inicial da busca. Ex.: 01/01/2023

string

Data final da busca. Ex.: 02/02/2023

Headers
string
required

Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json