/pix/key/delete Delete Pix Key (Unbind)
Background
/pix/key/delete unbinds the Pix Key submitted in the request. The endpoint is shared by merchants and partners. The Pix Key to unbind must already exist and be in the activated state.
Unbinding takes effect immediately and cannot be reversed: after unbinding, the Pix Key is no longer usable, and it must be registered again to be used.
Endpoint
| Item | Value |
|---|---|
| Method | DELETE |
| Path | /pix/key/delete |
| Content-Type | application/json |
| Purpose | Unbind a Pix Key |
Access Requirements
Request Fields
| Field | Location | Type | Max Length | Required | Description |
|---|---|---|---|---|---|
X-Merchant-Id | Header | string | 64 | Yes | Merchant ID of the integrator; partners use the primary merchant ID. |
X-Timestamp | Header | int | 19 | Yes | Unix request timestamp in seconds, used to validate request freshness. |
X-Nonce | Header | string | 64 | Yes | Anti-replay random string for the request. |
Digest | Header | string | 52 | Yes | For a DELETE request without a body, compute the digest over an empty byte string, in the format SHA-256=<Base64 digest>. |
Authorization | Header | string | Variable | Yes | ES256 request signature information, where keyId is the integrator's key version number. |
key | Query | string | 64 | Yes | The activated Pix Key to unbind; email, mobile number, CPF, CNPJ, or EVP are supported. |
This endpoint has no request body. key is placed in the query string, and (request-target) in the canonical string includes the raw query string exactly as sent.
Request Example
http
DELETE /pix/key/delete?key=financeiro%40example.com HTTP/1.1
Content-Type: application/json
X-Merchant-Id: 92315566000120
X-Timestamp: 1786867200
X-Nonce: 550e8400-e29b-41d4-a716-446655440005
Digest: SHA-256=<Base64 digest>
Authorization: Signature keyId="v1",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="<ES256_SIGNATURE_BASE64>"Response Fields
The endpoint uses the standard status, msg, and data response structure. On success, this endpoint returns only status and msg and does not return the data business field.
| Field | Type | Max Length | Always Returned | Description |
|---|---|---|---|---|
status | int | 4 | Yes | Response code; 200 indicates that the unbinding succeeded. |
msg | string | 128 | Yes | Corresponds to status; "sucesso" on success. |
Response Example
json
{
"status": 200,
"msg": "sucesso"
}