For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • GETList PIX Keys
      • POSTRegister PIX Key
      • GETGet PIX Key by Value
      • DELDelete PIX Key
LogoLogo
StatusDashboard
API ReferencePix Keys

Delete PIX Key

DELETE
https://api.brzip.com.br/api/v1/pix/keys/:key
DELETE
/api/v1/pix/keys/:key
$curl -X DELETE https://api.brzip.com.br/api/v1/pix/keys/key \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "success": true,
3  "data": {
4    "success": true,
5    "message": "PIX key deleted successfully"
6  }
7}

Removes a PIX key from DICT/BACEN.

URL parameter: key — the PIX key value Body: reason (optional, defaults to USER_REQUESTED)

Scope: pix:keys:write

Was this page helpful?
Previous

Get Balance

Next
Built with

Path parameters

keystringRequired
The PIX key value to delete

Request

This endpoint expects an object.
reasonenumOptionalDefaults to USER_REQUESTED
Reason for deletion
Allowed values:

Response

PIX key deleted successfully
successboolean
dataobject

Errors

404
Not Found Error