/pix/key/delete Pix Key 删除(解绑)接口
接口背景
/pix/key/delete 用于解绑请求上送的 Pix Key。商户和合作商共用本接口。待解绑的 Pix Key 必须已经存在且处于激活状态。
解绑立即生效且不可恢复:解绑后该 Pix Key 不再可用,如需再次使用须重新注册。
接口请求地址
| 项目 | 内容 |
|---|---|
| 请求方式 | DELETE |
| 请求路径 | /pix/key/delete |
| Content-Type | application/json |
| 接口用途 | 解绑 Pix Key |
接口接入规范
接口请求字段
| 字段名 | 位置 | 类型 | 字段长度 | 是否必填 | 说明 |
|---|---|---|---|---|---|
X-Merchant-Id | Header | string | 64 | 是 | 接入方商户号;合作商使用一级商户号。 |
X-Timestamp | Header | int | 19 | 是 | Unix 秒级请求时间戳,用于请求时效校验。 |
X-Nonce | Header | string | 64 | 是 | 请求防重放随机字符串。 |
Digest | Header | string | 52 | 是 | DELETE 请求无报文体时使用空字节串计算摘要,格式为 SHA-256=<Base64摘要>。 |
Authorization | Header | string | 不定长 | 是 | ES256 请求签名信息,其中 keyId 为接入方密钥版本号。 |
key | Query | string | 64 | 是 | 待解绑的已激活 Pix Key,支持邮箱、手机号、CPF、CNPJ 或 EVP。 |
本接口无请求体。key 放在 Query 中,签名串中的 (request-target) 包含实际发送的原始 Query 字符串。
请求示例
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摘要>
Authorization: Signature keyId="v1",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="<ES256_SIGNATURE_BASE64>"接口响应字段
接口使用统一的 status、msg、data 响应结构。本接口成功时仅返回 status 与 msg,不返回 data 业务字段。
| 字段名 | 类型 | 字段长度 | 是否必返 | 说明 |
|---|---|---|---|---|
status | int | 4 | 是 | 响应码;200 表示解绑成功。 |
msg | string | 128 | 是 | 与 status 对应,成功时为 "sucesso"。 |
响应示例
json
{
"status": 200,
"msg": "sucesso"
}