Decodificar QR Code ou Chave Pix

POST

/api/Pix/ConsultaDadosPagamentoPixQrCode

Pix

Funcionalidade principal

O endpoint ConsultaDadosPagamentoPixQrCode realiza a decodificação e consulta de um QR Code (ou chave Pix). Ele retorna os dados do recebedor, o valor da transação e, caso exista, os detalhes de uma recorrência (Pix Automático) associada.

Casos de uso comuns

Validação de QR Code dinâmico: O usuário escaneia um código em um checkout e o app consulta este endpoint para exibir o nome da loja e o valor correto.

Transferência por chave: Antes de enviar um Pix via CPF ou E-mail, o sistema consulta os dados para garantir que a chave pertence à pessoa correta.

Adesão ao Pix automático: Quando um QR Code contém instruções de recorrência, este endpoint detalha a periodicidade e o valor das parcelas para o aceite do pagador.

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/ConsultaDadosPagamentoPixQrCode' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "TextoQrCode": "string",
        "TransferenciaPorChave": false,
        "SomenteTarifaPix": false,
        "Valor": 0
    }
}'

Response Example

{
    "Data": {
        "Key": "string",
        "IdOrigem": "string",
        "Valor": 0,
        "Instituicao": "string",
        "Nome": "string",
        "CpfCnpj": 0,
        "CodigoBanco": 0,
        "Banco": "string",
        "Agencia": "string",
        "NumeroConta": "string",
        "TipoConta": "CACC",
        "TipoPessoa": "Fisica",
        "valorTarifaPix": 0,
        "PixAutomatico": {
            "TipoAutorizacao": "AUT1",
            "IdRec": "string",
            "Vinculo": {
                "Objeto": "string",
                "Devedor": {
                    "Cpf": "string",
                    "Cnpj": "string",
                    "Nome": "string"
                },
                "Contrato": "string"
            },
            "Calendario": {
                "DataInicial": "string",
                "DataFinal": "string",
                "Periodicidade": "string"
            },
            "Valor": {
                "ValorRec": "string",
                "ValorMinimoRecebedor": "string"
            },
            "Recebedor": {
                "Cnpj": "string",
                "Nome": "string",
                "IspbParticipante": "string",
                "NomeBancoParticipante": "string"
            },
            "PoliticaRetentativa": "string",
            "Atualizacao": [
                {
                    "Status": "string",
                    "Data": "string"
                }
            ]
        }
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:12:55

Página anterior

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

Próxima página

Confirmar liquidação de um Pix

Decodificar QR Code ou Chave Pix

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns