Guides/GuiasReferência APICryptoBrokers

Excluindo chave PIX

Este endpoint permite deletar uma chave PIX do usuário autenticado.

📍 Endpoint 

DELETE https://api.etherglobalassets.com.br/pix/keys/{id}

🧾 Cabeçalhos obrigatórios (Headers)

Cabeçalho

Valor

Descrição

Authorization

Bearer <token>

Token JWT de autenticação

🧰 Parâmetros da URL

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

id

string

✅

ID único da chave PIX a ser deletada

“uuid-12345678-1234-1234-1234-123456789012”

📌 Exemplo com curl 

curl https://api.etherglobalassets.com.br/pix/keys/uuid-12345678-1234-1234-1234-123456789012 \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

✅ Dica: Substitua <token> pelo seu JWT de autenticação válido e {id} pelo ID da chave PIX que deseja deletar.

✅ Resposta esperada (HTTP 200 - OK) 

{}

Explicação da resposta:

Campo

Tipo

Descrição

Exemplo

message

string

Mensagem de confirmação

“Chave PIX deletada com sucesso”

deletedKey

object

Dados da chave deletada

-

deletedKey.id

string

ID único da chave PIX

“uuid-12345678-1234-1234-1234-123456789012”

deletedKey.pixKey

string

Chave PIX deletada

“12345678901”

deletedKey.pixKeyType

enum

Tipo da chave PIX

“CPF”

deletedKey.deletedAt

string

Data/hora da exclusão

“2025-01-31T10:00:00Z”

⚠️ Possíveis erros

Código

Erro

Causa comum

400

Bad Request

ID da chave PIX inválido

401

Unauthorized

Token inválido ou ausente

404

Not Found

Chave PIX não encontrada

500

Internal Server Error

Erro interno do serviço

🎯 Como usar a exclusão de chaves PIX

Após receber a resposta, você pode:

  1. Confirmar exclusão: Use message para confirmar que a operação foi bem-sucedida

  2. Rastrear exclusão: Use deletedAt para saber quando a chave foi deletada

  3. Verificar dados: Use deletedKey para confirmar qual chave foi removida

  4. Atualizar interface: Remova a chave da lista de chaves ativas

  5. Registrar log: Use os dados para registrar a exclusão

🛡️ Limitações e restrições

✅ FAÇA:

  • Use o ID correto da chave PIX

  • Confirme que a chave pertence ao usuário autenticado

  • Verifique se a chave não está sendo usada em transações ativas

  • Confirme a exclusão antes de prosseguir

❌ NÃO FAÇA:

  • Tentar deletar chaves de outros usuários

  • Deletar chaves que estão sendo usadas em transações

  • Ignorar a confirmação de exclusão

  • Tentar deletar chaves já deletadas

🆘 Problemas comuns

“Estou recebendo erro 404!”

  • Verifique se o ID da chave PIX está correto

  • Confirme se a chave existe no sistema

  • Verifique se a chave pertence ao usuário autenticado

“Estou recebendo erro 400!”

  • Verifique se o ID da chave PIX é válido

  • Confirme se o formato do UUID está correto

  • Verifique se a chave não está sendo usada

“Erro 401!”

  • Verifique se o token de autenticação é válido

  • Faça uma nova autenticação se necessário

“A chave não foi deletada!”

  • Verifique se a chave não está sendo usada em transações

  • Confirme se a chave pertence ao usuário autenticado

  • Aguarde um momento e tente novamente

📞 Suporte

Se nada funcionar:

  1. Verifique o ID da chave PIX está correto

  2. Confirme a chave pertence ao usuário

  3. Entre em contato com nossa equipe de suporte

Mais informações sobre o endpoint:

Acesse aqui