Chaves Pix
Excluir uma chave Pix
Exclua chaves Pix cadastradas na conta quando não forem mais necessárias.
Visão Geral
Através deste endpoint você pode:
- Excluir chaves Pix cadastradas
- Remover chaves que não são mais utilizadas
- Gerenciar o conjunto de chaves da conta
Autenticação
Esta rota requer:
- Token JWT no header
Authorization(autenticaçãoauth:api) - Assinatura HMAC no header
X-Signature(middlewarehmac-signature)
Endpoint
Excluir Chave Pix
DELETE /api/v2/baas/key-managements/{id}
Exclui uma chave Pix cadastrada na conta.
Parâmetros de Rota
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID da chave Pix a ser excluída |
Headers
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
Authorization | string | Sim | Token JWT (Bearer {token}) |
X-Signature | string | Sim | Assinatura HMAC da requisição |
Accept | string | Sim | application/json |
Exemplo de Requisição
DELETE /api/v2/baas/key-managements/123
Resposta de Sucesso (204)
A resposta de sucesso não possui corpo. O código de status 204 No Content indica que a chave foi excluída com sucesso.
Respostas de Erro
400 - Chave Não Encontrada
{
"message": "Key not found"
}
400 - Chave Não Pertence à Conta
{
"message": "Key does not belong to this account"
}
400 - Erro Interno do Servidor
O erro será capturado por ferramentas internas de captura de excessões e o erro será tratado internamento liberando a funcionalidade o mais rápido possível.
{
"message": "Ocorreu um erro ao deletar a chave, tente novamente em alguns minutos."
}
401 - Não Autenticado
{
"message": "Unauthorized"
}
403 - Acesso Negado
{
"message": "Forbidden"
}
429 - Rate Limit Excedido
{
"message": "Too Many Requests"
}
Regras de Negócio
Exclusão de Chave
- A chave é excluída permanentemente do sistema
- Após a exclusão, a chave não pode mais ser utilizada para receber pagamentos
- A exclusão é processada tanto no sistema local quanto no sistema do Banco Central
Validações
- A chave deve pertencer à conta autenticada
- A chave deve existir e estar cadastrada
- O seller deve ter permissão para excluir a chave
Impacto da Exclusão
- Após excluir uma chave, ela não pode mais ser utilizada
- Pagamentos enviados para a chave excluída falharão
- Recomenda-se manter pelo menos uma chave ativa na conta
Próximos Passos
Após excluir uma chave Pix, você pode:
- Criar uma nova Chave se necessário
- Consultar Chaves para verificar chaves restantes
- Realizar Pagamentos usando outras chaves