Receber
Listar cobranças PIX
Lista cobranças PIX (PIX_IN) com paginação e filtros.
GET
Parâmetros de query
number
Número da página (padrão 1).
number
Itens por página (padrão 50, máximo 100).
string
ISO 8601 — início do período (
createdAt).string
ISO 8601 — fim do período (
createdAt).string
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED ou REVERSED.
string
Filtro exato pela referência externa.
string
Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Available options:
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED, REVERSED Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.
Filtra transações vinculadas à subconta merchant (PIX com subaccountId na criação, movimentações internas, MED/reembolso, etc.). Alias de merchantSubaccountId. Quando informado, o filtro de trilho PIX da API key é ignorado.
Mesmo filtro que subaccountId.

