查询企业主账号可拨款余额
功能介绍
企业主账号在自建平台查询自己的可拨款余额。
接口约束
该接口只允许使用客户账号AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/enterprises/multi-accounts/transfer-amount
参数说明请参见下表。
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
balance_type |
是 |
String |
最大长度:64 |
账户类型:
|
offset |
否 |
Integer |
[0-2147483647] |
偏移量,默认值为0。只有信用账户有效。
说明:
offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 |
limit |
否 |
Integer |
[1-100] |
每次查询条数,默认值为10。只有信用账户有效。 |
请求消息
请求参数
无。
请求示例
GET https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/transfer-amount?balance_type=BALANCE_TYPE_DEBIT&offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:16 |
状态码。具体请参考状态码。只有失败才会返回这个参数。 |
error_msg |
String |
最大长度:1024 |
错误描述信息。只有失败才会返回这个参数。 |
total_count |
Integer |
- |
记录条数。 |
amount_infos |
List<TransferAmountInfoV2> |
- |
可拨款余额信息,如果是余额账户,只会有一条记录。 具体请参见表2。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
avail_transfer_amount |
BigDecimal |
- |
可拨款的金额。 |
measure_id |
Integer |
- |
金额单位。 1:元 |
currency |
String |
最大长度:8 |
币种。 CNY:人民币 |
amount |
BigDecimal |
- |
账户余额(仅balance_type=信用账户时这个字段才有值)。 |
credit_amount |
BigDecimal |
- |
信用额度(仅balance_type=信用账户时这个字段才有值)。 |
expire_time |
String |
最大长度:20 |
信用额度过期时间。 UTC时间,格式为:2016-03-28T14:45:38Z。 (仅balance_type=信用账户时这个字段才有值)。 如果查询信用账户可拨款余额的查询结果没有失效时间,表示永久有效。 |
响应示例
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 1, "amount_infos": [ { "avail_transfer_amount": 9.99, "measure_id": 1, "currency": "CNY", "amount": null, "credit_amount": null, "expire_time": null } ] }