v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
QR Code - Cliente

QR Code - Consultar

get/pix/direto/forintegration/v1/qrcodes

Query parameters

Tipo'Estatico' | 'Dinamico'

Filtro pelo tipo do QR Code.

TxIdstring nullable

Identificador da transação.

Identificador da transação.

Status'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP'

Filtro pelo status do QR Code.

StatusDomínioSignificado
ATIVA1Qrcode ainda está ativo e pode receber pagamentos.
CONCLUIDA2Qrcode foi pago (Apenas se aplica para qrcode dinamico e qrcode dinamico com vencimento).
REMOVIDA_PELO_USUARIO_RECEBEDOR3Qrcode foi expirado.
REMOVIDA_PELO_PSP4Qrcode foi cancelado.
Iniciostring 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.

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

Fimstring 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.

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

Paginacao.PaginaAtualinteger

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

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

Paginacao.ItensPorPaginainteger

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

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

Response

Success