Consulta Pix
Obtenha informações de chaves Pix
A API Consulta Pix permite que você obtenha informações de uma chave Pix, como nome do receptor, instituição bancária, conta, CPF ou CNPJ.
Casos de Uso
- Consultar uma chave Pix.
- Fornecer informações ao cliente antes de um pagamento via Pix.
Segurança
BTG Id
O Authorization Server do BTG Empresas se chama BTG Id. Usando o BTG Id, um aplicativo parceiro consegue consentimento e autorização para executar operações nas APIs do BTG em nome do cliente. Para saber mais, acesse a documentação do BTG Id
Escopos necessários
O token para consumir a API Consulta Pix deve ser gerado usando o Authorization Code.
O escopo openid
é obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta.
Recursos Disponíveis
Com a API Consulta Pix, você pode pesquisar uma chave Pix pelo CPF ou CNPJ, telefone, e-mail ou string aleatória.
Os recursos da API Consulta Pix estão disponíveis no API Reference.
API Reference
Updated about 1 month ago