Consultar status e dados de um QR Code dinâmico

POST

/api/Pix/ConsultarDynamicQrCode

Pix

Funcionalidade principal

Este endpoint é utilizado para consultar o status e os dados de um QR Code Dinâmico ou Composto que já foi gerado. É a ferramenta principal para verificar se um QR Code foi pago ou se expirou.

A consulta é realizada utilizando o PinbankQrCodeId, o identificador único que é retornado pela API no momento da geração do QR Code. A resposta trará o estado atual da cobrança (ex: "Pendente", "Pago", "Expirado") e, caso tenha sido paga, os detalhes da transação correspondente.

Casos de uso comuns

Verificar manualmente o status de um pagamento em uma tela de suporte ou painel administrativo.

Implementar uma rotina de verificação no lado do cliente (front-end) que consulta este endpoint periodicamente para atualizar a tela após o pagamento.

Validar se um QR Code ainda está ativo antes de exibi-lo novamente para um cliente.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/Pix/ConsultarDynamicQrCode' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "PinbankQrCodeId": 0
    }
}'

Response Example

{
    "Data": {
        "PinbankQrCodeId": 0,
        "StatusQrCodeRc": "QRCODE_PENDENTE",
        "StatusQrCode": "QRCODE_PENDENTE",
        "TextoQrCode": "string",
        "QrCodePixLink": "string",
        "Referencia": "string",
        "QrCodeURL": "string",
        "TxId": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:11:14

Página anterior

Gerar QR Code dinâmico ou composto com recorrência

Próxima página

Invalidar QR Code dinâmico de cobrança Pix pendente

Consultar status e dados de um QR Code dinâmico

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns