查询企业子账号可回收余额（旧）
功能介绍
企业主账号在自建平台查询企业子账号的可回收余额。
注意事项：
该接口只允许使用企业主账号AK/SK或者Token调用。
URI
GET /v1.0/{domain_id}/customer/account-mgr/retrieve-amount
参数说明请参见下表。
|
参数 |
是否必选 |
取值范围 |
描述 |
|---|---|---|---|
|
domain_id |
是 |
最大长度：64 |
客户账号ID，只能使用企业主账号。 获取方法请参见如何获取客户的customer_id/domain_id。 |
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
sub_customer_id |
是 |
String |
最大长度：64 |
企业子账户的账号ID。 |
|
balance_type |
是 |
String |
最大长度：64 |
账户类型： BALANCE_TYPE_DEBIT：余额账户（默认）； BALANCE_TYPE_CREDIT：信用账户。 |
|
offset |
否 |
Integer |
[1-200000000] |
页码（默认1）。只有信用账户有效。 当balance_type为信用账户时：此参数不携带或携带值为空或携带值为null时，取值为1；不支持携带值为空串。 当balance_type为余额账户时：此参数不携带或携带值为空或携带值为null时，参数无效；不支持携带值为空串。 |
|
limit |
否 |
Integer |
[1-100] |
每页记录数（默认10）。只有信用账户有效。 当balance_type为信用账户时：此参数不携带或携带值为空或携带值为null时，取值为1；不支持携带值为空串。 当balance_type为余额账户时：此参数不携带或携带值为空或携带值为null时，参数无效；不支持携带值为空串。 |
请求消息
请求参数
无。
请求示例
GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/customer/account-mgr/retrieve-amount?balance_type=BALANCE_TYPE_DEBIT&sub_customer_id=16*****e7e HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
error_code |
String |
最大长度：16 |
状态码。具体请参考状态码。只有失败才会返回这个参数。 |
|
error_msg |
String |
最大长度：1024 |
错误描述信息。只有失败才会返回这个参数。 |
|
totalCount |
Integer |
- |
记录条数。 |
|
amountInfo |
List<RetrieveAmountInfo> |
- |
可回收余额信息，如果是余额账户，只会有一条记录。 具体请参见AmountInfo。 |
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
availRetrieveAmount |
BigDecimal |
- |
可回收的金额。 |
|
measureId |
Integer |
- |
金额单位。 1：元 |
|
currency |
String |
最大长度：8 |
币种。 CNY：人民币 |
|
amount |
BigDecimal |
- |
账户余额（仅balance_type=信用账户时这个字段才有值）。 |
|
creditAmount |
BigDecimal |
- |
信用额度（仅balance_type=信用账户时这个字段才有值）。 |
|
expireTime |
String |
最大长度：20 |
信用额度过期时间。 UTC时间，格式为：2016-03-28T14:45:38Z。 如果查询信用账户可回收余额的查询结果没有失效时间，表示永久有效。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"totalCount": 1,
"amountInfo": [
{
"availRetrieveAmount": 6689.9,
"measureId": 1,
"currency": "CNY",
"amount": null,
"creditAmount": null,
"expireTime": null
}
]
}
