Pagamento - Consultar informações de chave pix
Permite que usuários autorizados acessem e recuperem detalhes sobre chaves Pix específicas registradas no sistema de pagamentos. Essa funcionalidade facilita a identificação precisa de chaves Pix e seus respectivos dados bancários, contribuindo para a segurança e confiabilidade das transações Pix.
Funcionalidades Essenciais:
- Consulta por Chave Pix: Os usuários podem consultar informações sobre uma chave Pix específica fornecendo a chave completa (com dígito verificador) ou apenas parte da chave.
- Recuperação de Detalhes da Chave: A API recupera e retorna informações relevantes sobre a chave Pix consultada, incluindo:
- Titular da conta (nome completo ou razão social)
- Banco
- Tipo de conta (corrente ou poupança)
- Agência
- Conta
- Validação de Chave Pix: A API verifica a validade da chave Pix consultada, garantindo que seja uma chave Pix válida e registrada no sistema.
- Prevenção de Fraudes: A consulta de informações de chaves Pix contribui para a prevenção de fraudes, pois permite que os usuários confirmem a identidade e os dados bancários do recebedor antes de realizar uma transação.
Requisição
| Campo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| cpfOperador | Texto | CPF do recebedor | Sim |
| contaOrigem | Texto | Conta da qual se origina o pagamento com o digito verificador. | Sim |
| type | Texto | Tipo da chave | Sim |
| phoneNumber | Texto | Número de telefone | Não |
| Texto | Email chave pix | Não | |
| randomKey | Texto | Chave Aleatória | Não |
| code | Texto | Código cópia e cola | Não |
| documentNumber | Texto | Número de documento (CPF ou CNPJ) | Não |
| bank | Texto | Código do banco | Não |
| bankName | Texto | Nome do banco | Não |
| agency | Texto | Número da agência | Não |
| account | Texto | Número da conta | Não |
| name | Texto | Nome do destinatário | Não |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| message | Texto | Mensagem da consulta |
| key | Texto | Chave pix |
| bank | Texto | Banco consultado |
| name | Texto | Nome consultado |
| cpf_cnpj | Texto | CPF ou CNPJ consultado |
| agency | Texto | Agência consultada |
| number | Texto | Número consultado |