清算账户查询
本端点用于查询某个发行人清算账户的详细信息 — 银行数据(分行、账号、校验位)、状态,以及在账户已开立时的持有人信息与余额。
在账户尚未在 BaaS 中开立之前,本端点仅返回基础数据,且 account_status: "pending"。账户开立之后,响应中会包含额外的持有人字段与余额字段。
清算账户查询(GET)
Request
ENDPOINT
/account_liquidation/issuer/ISSUER-KEY方法
GETPath Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ISSUER-KEY | string | 发行人的唯一键值(UUID v4)。 | 36 |
Response
STATUS
200Response Body — 账户已开立
{
"issuer_key": "23d933e9-88ba-4291-a6a4-33f025ab361f",
"tenant_key": "5e3045af-8be8-4cbd-9aab-9e15c4e92154",
"bank_account_key": "8f2a6f10-3c43-4a3b-9f5e-2a9a1d4be0c1",
"request_account_key": "1c0a2e54-77a8-4f0e-8d8e-6f2b9b3c1d22",
"account_key": "46804f32-101e-4702-8fbc-c2dbc4c2caec",
"account_branch": "0001",
"account_number": "1234567",
"account_digit": "8",
"account_status": "opened",
"account_type": "payment_account",
"account_documents": [],
"balance": 12345.67,
"blocked_balance": 0.0,
"owner_document_number": "12345678000190",
"owner_name": "Emissor Exemplo LTDA",
"owner_person_key": "9b1f3c77-5a2d-4e8f-b6a0-3d2c1e0f9a88",
"created_at": "2026-01-15T12:34:56"
}
Response Body — 账户待开立
{
"issuer_key": "23d933e9-88ba-4291-a6a4-33f025ab361f",
"tenant_key": "5e3045af-8be8-4cbd-9aab-9e15c4e92154",
"bank_account_key": "8f2a6f10-3c43-4a3b-9f5e-2a9a1d4be0c1",
"request_account_key": "1c0a2e54-77a8-4f0e-8d8e-6f2b9b3c1d22",
"account_branch": "0001",
"account_number": "1234567",
"account_digit": "8",
"account_status": "pending"
}
Response Body Params
| 字段 | 类型 | 描述 |
|---|---|---|
issuer_key | string | 发行人的唯一键值。 |
tenant_key | string | 持有该账户的客户的唯一键值。 |
bank_account_key | string | 该银行账户在 BaaS 中的唯一键值。 |
request_account_key | string | 开户申请的唯一键值。 |
account_key | string | 该账户在 BaaS 中的唯一键值。仅在账户已开立时出现。 |
account_branch | string | 账户所属分行。 |
account_number | string | 账号。 |
account_digit | string | 账号校验位。 |
account_status | string | 账户状态。开户尚未完成时为 pending。 |
account_type | string | 该账户在 BaaS 中的类型。仅在账户已开立时出现。 |
account_documents | array | 与该账户关联的文件。仅在账户已开立时出现。 |
balance | number | 账户可用余额。仅在账户已开立时出现。 |
blocked_balance | number | 账户冻结余额。仅在账户已开立时出现。 |
owner_document_number | string | 账户持有人的 CPF/CNPJ。仅在账户已开立时出现。 |
owner_name | string | 账户持有人姓名/名称。仅在账户已开立时出现。 |
owner_person_key | string | 持有人在 BaaS 中的唯一键值。仅在账户已开立时出现。 |
created_at | string | 账户创建日期。仅在账户已开立时出现。 |
错误
| HTTP | 错误码 | 触发场景 |
|---|---|---|
| 404 | ACL000002(IssuerAccountLiquidationNotFound) | 所提供的发行人不存在清算账户。 |
| 400 | ACL000003(IssuerAccountLiquidationNotBelongToTenant) | 该发行人的清算账户不属于发起请求的客户。 |