Deletar chave

Sandbox

https://horizon-api-sb.app.rpe.tech

DELETE

/api/v1/pixcard/chave

Use este endpoint para excluir uma chave associada a uma conta (idAccount).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/chave' \
--header 'Accept: */*' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idAccount": 1634554,
    "key": "[email protected]",
    "description": " Unique example id 19021",
    "deleteType": "email",
    "claimUUID": "123e4567-e89b-12d3-a456-426655440000"
}'

Response Example

200 - Example 1

{
    "message": "Chave deletada",
    "idAccount": 2001,
    "ispb": "12345678",
    "keyType": "nationalRegistration",
    "key": "[email protected]",
    "description": "Email",
    "keyStatus": "OPEN",
    "claimUUID": "123e4567-e89b-12d3-a456-426655440001"
}