Consultar Pix recebidos.

Endpoint para consultar Pix recebidos

Query Params
date-time
required

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

date-time
required

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

string
[a-zA-Z0-9]{26,35}

Identificador da transação

O campo txid determina o identificador da transação.
O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.
Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.
Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e,
depois de confirmado o pagamento, é enviado para o SPI via pacs.008.
Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais
do pagamento, o txid.
Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor,
informando que um pagamento específico foi liquidado.
O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade.
O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao
PSP recebedor validar essa regra na API Pix.

boolean
boolean
string
/^\d{11}$/

Filtro pelo CPF do pagador. Não pode ser utilizado ao mesmo tempo que o CNPJ.

string
/^\d{14}$/

Filtro pelo CNPJ do pagador. Não pode ser utilizado ao mesmo tempo que o CPF.

int32
≥ 0
Defaults to 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

int32
1 to 1000
Defaults to 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

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