Remover chave Pix
DELETE /accounts/:accountId/pix/keys/:key — path param é o valor da chave (URL-encoded).
Remover chave Pix
Remove uma chave Pix cadastrada. O path param é o valor da chave (não o id) — sempre URL-encoded, especialmente em e-mails (@ → %40) e telefones com sinal de + (+ → %2B). Resposta vazia (204 No Content).
DELETE/accounts/:accountId/pix/keys/:key
Path param é o valor da chave, NÃO o key.id retornado em GET /pix/keys. URL-encode obrigatório: @ vira %40, + vira %2B. Resposta sucesso vem sem body (204 No Content). Depois de remover, a chave deixa de receber Pix imediatamente; pra voltar a usá-la é preciso cadastrar de novo (EMAIL/PHONE exige novo OTP).
Path params
- accountIdObrigatóriostring (UUID)ID da conta dona da chave.
- keyObrigatóriostring (URL-encoded)Valor da chave a remover: e-mail, telefone E.164, CPF/CNPJ apenas dígitos ou UUID (EVP). Sempre URL-encoded.
Headers
- AcceptObrigatóriostringapplication/json
- AuthorizationObrigatóriostringBearer <token> — JWT de /authenticate.
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Exemplo de requisição
curl -X DELETE "https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/pix/keys/fulano%40example.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \ -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"Resposta
json
// Sem body. Sucesso indicado pelo status HTTP 204 (No Content).URL base:
https://baas.staterpay.io