API Reference

Consultar transação PIX IN

get
https://api.voidxpay.com/v1/pix-in

Endpoint dual-purpose para consulta e listagem de transações PIX IN.

Modo 1 — Busca unitária

Se id ou externalRef for informado, retorna uma única transação.

Modo 2 — Listagem com filtros

Se nenhum dos parâmetros de busca unitária for informado, retorna uma lista paginada de transações com filtros opcionais por status, startDate e endDate.

Os resultados são ordenados do mais recente para o mais antigo. A paginação é baseada em cursor (pageToken).

Query Params
uuid

(Busca unitária) ID interno da transação (UUID). Se informado, retorna apenas a transação correspondente.

string

(Busca unitária) Referência externa definida na criação do pagamento. Se informado (e id não encontrar), retorna a transação correspondente.

string

(Busca unitária) Identificador end-to-end do PIX (gerado pelo Banco Central). Indexado via GSI EndToEndIndex para consulta otimizada. Usado como fallback se id e externalRef não encontrarem a transação.

string
enum

(Listagem) Filtrar transações por status.

date-time

(Listagem) Data início do período (ISO 8601). Filtra pelo campo createdAt.

date-time

(Listagem) Data fim do período (ISO 8601). Filtra pelo campo createdAt.

integer
1 to 100
Defaults to 20

(Listagem) Máximo de resultados por página. Padrão: 20, máximo: 100.

string

(Listagem) Cursor para a próxima página, retornado no campo pagination.nextPageToken da resposta anterior. Quando nextPageToken for null, não há mais resultados.

Responses

Updated about 2 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago