Listando chaves PIX
Este endpoint permite listar todas as chaves PIX do usuário autenticado.
📍 Endpoint
GET https://api.etherglobalassets.com.br/pix/keys
🧾 Cabeçalhos obrigatórios (Headers)
|
Cabeçalho |
Valor |
Descrição |
|---|---|---|
|
Authorization |
Bearer <token> |
Token JWT de autenticação |
📌 Exemplo com curl
curl https://api.etherglobalassets.com.br/pix/keys \
--request GET \
--header 'Authorization: Bearer <token>'
✅ Dica: Substitua <token> pelo seu JWT de autenticação válido.
✅ Resposta esperada (HTTP 200 - OK)
[
{
"id": "uuid-12345678-1234-1234-1234-123456789012",
"pixKey": "12345678901",
"pixKeyType": "CPF",
"createdAt": "2025-01-31T10:00:00Z",
"isActive": true,
"bankName": "BCO SANTANDER (BRASIL) S.A."
},
{
"id": "uuid-87654321-4321-4321-4321-210987654321",
"pixKey": "usuario@exemplo.com",
"pixKeyType": "EMAIL",
"createdAt": "2025-01-30T15:30:00Z",
"isActive": true,
"bankName": "BANCO DO BRASIL S.A."
}
]
Explicação da resposta:
|
Campo |
Tipo |
Descrição |
Exemplo |
|---|---|---|---|
|
id |
string |
ID único da chave PIX |
“uuid-12345678-1234-1234-1234-123456789012” |
|
pixKey |
string |
Chave PIX |
“12345678901” |
|
pixKeyType |
enum |
Tipo da chave PIX |
“CPF” |
|
createdAt |
string |
Data de criação da chave PIX |
“2025-01-31T10:00:00Z” |
|
isActive |
boolean |
Status da chave PIX (ativa/inativa) |
true |
|
bankName |
string |
Nome da instituição bancária |
“BCO SANTANDER (BRASIL) S.A.” |
Tipos de Chave PIX:
|
Tipo |
Descrição |
Exemplo |
|---|---|---|
|
CPF |
CPF da pessoa física |
“12345678901” |
|
CNPJ |
CNPJ da pessoa jurídica |
“12345678000199” |
|
|
Email válido |
|
|
PHONE |
Telefone com DDD |
“11999999999” |
|
RANDOM |
Chave aleatória |
“550e8400-e29b-41d4-a716-446655440000” |
⚠️ Possíveis erros
|
Código |
Erro |
Causa comum |
|---|---|---|
|
401 |
Unauthorized |
Token inválido ou ausente |
|
500 |
Internal Server Error |
Erro interno do serviço |
🎯 Como usar as chaves PIX
Após receber a resposta, você pode:
-
Listar chaves: Use o array para mostrar todas as chaves disponíveis
-
Verificar status: Use
isActivepara verificar se a chave está ativa -
Identificar tipos: Use
pixKeyTypepara diferenciar os tipos de chave -
Validar bancos: Use
bankNamepara identificar a instituição bancária -
Rastrear criação: Use
createdAtpara ver quando a chave foi criada
🛡️ Limitações e restrições
✅ FAÇA:
-
Use o campo
isActivepara verificar chaves ativas -
Verifique o
pixKeyTypeantes de usar a chave -
Considere o
bankNamepara identificação da instituição -
Use o
idpara referenciar chaves específicas
❌ NÃO FAÇA:
-
Ignorar o status
isActivedas chaves -
Usar chaves inativas para transações
-
Assumir que todas as chaves são do mesmo tipo
-
Expor dados sensíveis das chaves PIX
🆘 Problemas comuns
“Estou recebendo erro 401!”
-
Verifique se o token de autenticação é válido
-
Faça uma nova autenticação se necessário
“A lista está vazia!”
-
Verifique se o usuário tem chaves PIX cadastradas
-
Confirme se as chaves não foram deletadas
“Algumas chaves não aparecem!”
-
Verifique se as chaves estão com
isActive: true -
Confirme se não há filtros aplicados
📞 Suporte
Se nada funcionar:
-
Verifique a autenticação está válida
-
Confirme se há chaves cadastradas
-
Entre em contato com nossa equipe de suporte
Mais informações sobre o endpoint:
Acesse aqui