QR Code - Consultar

get

https://example.com/pix/direto/forintegration/v1/qrcodes

Query Params

Tipo

string

enum

Filtro pelo tipo do QR Code.

Allowed:

TxId

string | null

Identificador da transação.

Status

string

enum

Filtro pelo status do QR Code.

Status	Domínio	Significado
ATIVA	1	Qrcode ainda está ativo e pode receber pagamentos.
CONCLUIDA	2	Qrcode foi pago (Apenas se aplica para qrcode dinamico e qrcode dinamico com vencimento).
REMOVIDA_PELO_USUARIO_RECEBEDOR	3	Qrcode foi expirado.
REMOVIDA_PELO_PSP	4	Qrcode foi cancelado.

Allowed:

Inicio

date-time

required

Filtra os registros cuja data de criação seja maior ou igual a data de início. Obrigatório se não informado TxId.

Fim

date-time

required

Filtra os registros cuja data de criação seja menor ou igual a data de fim. Obrigatório se não informado TxId.

Paginacao.PaginaAtual

int32

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

Paginacao.ItensPorPagina

int32

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

Responses

Language

Loading…

Response

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

application/json