Delete Pix Key
DELETE/pix/keys/:id
Delete a pix key associated with the specified ID. After deletion, the pix key's state will be set to DELETING.
Request
Path Parameters
id stringrequired
Pix Key ID.
Header Parameters
nonce stringrequired
The nonce ID is a UUID (v4) used to uniquely identify the requisition. All requisitions must have an identifier.
Responses
- 200
- 400
- 401
- 404
- 422
The pix key returned successfully.
- application/json
- Schema
- Example (from schema)
Schema
id stringrequired
Pix Key ID.
key stringrequired
Pix Key.
type objectrequired
Pix Key Type.
state objectrequired
Pix Key State.
created_at date-timerequired
Pix Key created at.
{
"id": "f6e2e084-29b9-4935-a059-5473b13033aa",
"key": "f6e2e084-29b9-4935-a059-5473b13033aa",
"type": "EVP",
"state": "DELETING",
"created_at": "2024-11-22T13:43:07.728Z"
}
If any required params are missing or has invalid format or type.
User authentication failed.
If the key id was not found.
If any required params are missing or has invalid format or type.
Loading...