跳到主要内容

列出账户的 Pix 密钥

Request

ENDPOINT
/baas/pix/keys
MÉTODO
GET

Query Params

字段类型描述字符数
account_key*string账户 uuid 键uuid 键
pix_key_statusenumPix Key Status 枚举值 指示应返回的 Pix 密钥状态-

枚举值 Pix Key Status

枚举值描述
pending_confirmation等待确认
active有效
inactivated无效
pending_claim_request_confirmation等待 Pix 密钥可携性申请确认

Response

STATUS
200
Response Body
[
{
"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
"pix_key": "63927180432",
"pix_key_status": "active",
"pix_key_type": "cpf",
"updated_at": "2022-09-02T20:00:36",
"created_at": "2022-09-02T20:00:36"
},
{
"account_key": "40cea00e-9d99-46f9-b55f-dbafa84553a9",
"pix_key": "+5562985013819",
"pix_key_status": "pending_confirmation",
"pix_key_type": "phone_number",
"updated_at": "2022-09-02T20:00:36",
"created_at": "2022-09-02T20:00:36"
},
{
"account_key": "0ebc3bfb-be25-4093-adf2-f0cdee6f5e69",
"pix_key": "address@email.com",
"pix_key_status": "pending_confirmation",
"pix_key_type": "email",
"updated_at": "2022-09-02T20:00:36",
"created_at": "2022-09-02T20:00:36"
}
]
STATUS
400
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}