DELETE /v1/pix/keys/{accountId}

Ao utilizar este endpoint, é possível remover uma chave PIX específica da sua conta Agavos, impedindo que transações indesejadas sejam realizadas. A exclusão da chave PIX também pode ser útil em casos de perda ou roubo do dispositivo móvel que contém a chave.

Body

  • account string
  • pixKeyType string

    Values are PHONE, EMAIL, RANDOM, CNPJ, or CPF.

  • pixKey string

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • code integer
    • data object
      Hide data attributes Show data attributes object
      • Key string
      • Success string
      • Message string
DELETE /v1/pix/keys/{accountId} 
curl \
 -X DELETE https://sandbox.agavos.com.br/v1/pix/keys/{accountId} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"account":"asdb1238asd0asd1b1238asdb123123asd","pixKeyType":"0","pixKey":"123444012399"}'
Request example 
{
  "account": "asdb1238asd0asd1b1238asdb123123asd",
  "pixKeyType": "0",
  "pixKey": "123444012399"
}
Request examples 
{
  "pixKey": "123444012399",
  "account": "asdb1238asd0asd1b1238asdb123123asd",
  "pixKeyType": "0"
}
Response examples (200) 
{
  "code": 0,
  "data": {
    "Success": "true",
    "Message": "Solicitação para cancelamento de chave do tipo Aleatória recebida com sucesso.",
    "Key": "asd1239asdb123asd9123basd9a123123123"
  }
}
Response examples (200) 
{
  "code": 0,
  "data": {
    "Key": "asd1239asdb123asd9123basd9a123123123",
    "Message": "Solicitação para cancelamento de chave do tipo Aleatória recebida com sucesso.",
    "Success": "true"
  }
}