封禁或重新激活 Keys

POST

https://api.cobre.co/v1/accounts/{acct_id}/keys/{key_id}/key_action

该接口支持对 Cobre Key 执行相应操作。

各操作及其对应原因如下：

action	description	Allowed reasons
enable	重新激活当前状态为 `disabled`（已禁用）的密钥。执行后，密钥将恢复至 `registered`（已注册）状态，可不受限制地正常使用。	`client_request`
disable	根据客户请求封禁密钥。执行后，相关密钥将转为 `disabled`（已禁用）状态，无法用于任何操作。	`client_request`

原因的选择取决于操作发起方，且必须包含在 API 请求体中。

该功能目前处于 Beta 阶段，可能有所调整。目前暂不支持在生产环境中使用。

参见 Cobre Keys 与 Bre-B 指南

常见错误

封禁 key_id 时误以为后续可以重新激活。

假设操作即时生效，未检查密钥状态的更新结果。

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200Correcto

application/json

Bodyapplication/json

🟠404No encontrado

🟠409Conflicto

Request Example

Shell

JavaScript

Java

Swift

cURL

禁用 Key启用 Key

curl --location 'https://api.cobre.co/v1/accounts//keys//key_action' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "action": "disable",
    "reason": "client_request"
}'

Response Example

200 - 禁用 Key

{
    "id": "key_TQjvIO8UFf1bv81",
    "alias": "My first Cobre Key",
    "connectivity": {
        "status": "registered",
        "description": ""
    },
    "previous_action": {
        "action_requested": "disable",
        "action_code": "",
        "action_description": ""
    },
    "created_at": "2025-11-28T21:32:08Z",
    "updated_at": "2025-11-28T21:32:09Z"
}

Modified at 2026-06-12 23:18:07

注销 Key

为 Direct Debit 注册交易对手方

封禁或重新激活 Keys

常见错误#

Request

Responses

常见错误