PIX 密钥

列出与 API Key 关联账户中已注册的 PIX 密钥。

接口

GET /api/external/pix/keys

请求头

请求头	类型	必填	说明
Authorization	String	是	ApiKey {client_id}:{client_secret}

示例

curl -X GET https://api.owem.com.br/api/external/pix/keys \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

成功响应 (200)

{
  "worked": true,
  "keys": [
    {
      "key": "12345678901",
      "key_type": "cpf",
      "status": "active",
      "created_at": "2026-02-05T12:00:00Z"
    },
    {
      "key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "key_type": "evp",
      "status": "active",
      "created_at": "2026-02-10T14:30:00Z"
    },
    {
      "key": "contato@empresa.com.br",
      "key_type": "email",
      "status": "active",
      "created_at": "2026-02-15T09:00:00Z"
    }
  ]
}

字段	类型	说明
worked	Boolean	true 表示操作成功
keys	Array	账户的 PIX 密钥列表
keys[].key	String	PIX 密钥值
keys[].key_type	String	密钥类型（见下表）
keys[].status	String	密钥当前状态
keys[].created_at	String	注册日期（ISO 8601）

密钥类型

类型	格式	示例
cpf	11 位数字	12345678901
cnpj	14 位数字	12345678000190
email	有效电子邮件	contato@empresa.com.br
phone	+55 + 区号 + 号码	+5511999998888
evp	UUID v4（随机密钥）	a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

密钥状态

状态	说明
active	密钥已激活，可正常使用
pending	正在 DICT 中处理注册
portability	正在进行携号转移

错误响应 (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

各类型密钥数量限制

个人账户（PF）：最多 5 个密钥。企业账户（PJ）：最多 20 个密钥。每个账户仅允许绑定 1 个 CPF/CNPJ 密钥。