列出 Alias 的 PIX 密钥

请求

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_key

MÉTODO

GET

路径参数

字段	类型	描述	字符数
account_key	string	账户唯一密钥。	36
alias_key	string	Alias 唯一密钥。	36

PIX 密钥类型

"pix_key" 为随机密钥（UUID4）类型，格式如下：

随机密钥：UUID4。

查询参数

字段	类型	描述	字符数
page_number	integer	当前查询的页码。	-
page_size	integer	每页结果数量。	-

响应

STATUS

200

响应体：活跃密钥

{
  "data": [
    {
      "pix_key": "ecdb1790-667f-42ab-b319-fbc838a04672",
      "pix_key_type": "random_key",
      "pix_key_status": "active",
      "created_at": "2021-10-22T20:30:23.459Z"
    },
    {
      "pix_key": "f5eb52c1-5247-4de3-9982-f4f0ee9edad4",
      "pix_key_type": "random_key",
      "pix_key_status": "active",
      "created_at": "2021-12-06T21:16:12.123Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 10
  }
}

响应体参数

字段	类型	描述	最大字符数
pix_key	string	PIX 密钥。	77
pix_key_type	string	PIX 密钥类型。可以是 "random_key"	10
pix_key_status	string	PIX 密钥激活状态。可以是 "active"、"inactive" 或 "pending"	8
created_at	datetime Zulu	请求创建日期。	20

STATUS

4XX

响应体：错误

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP 状态码	QI 错误码 code	标题 title	英文描述 Description	葡文描述 translation
403	PIX000080	Not enough permission	The selected agent is not an Pix Indirect Participant	O agente selecionado não é um Participante Indireto do Pix
404	PIX000082	Alias not found	Alias {alias_key} not found	Alias {alias_key} não encontrado
400	PIX000088	Page size too large	Requested page size above limit of {max_page_size}	Tamanho de página requerido acima do limite de {max_page_size}
400	PIX000089	Invalid value for params	Page Size and Page Number must be integers	age Size e Page Number devem ser números inteiros