更新时间:2023-03-31 GMT+08:00
分享

查询企业主账号可拨款余额

功能介绍

企业主账号在自建平台查询自己的可拨款余额。

注意事项:

该接口只允许使用企业主账号AK/SK或者Token调用。

该接口即将下线,“查询企业主账号可拨款余额”接口请参考查询企业主账号可拨款余额

URI

GET /v1.0/{domain_id}/customer/account-mgr/transfer-amount

参数说明请参见下表。

表1 路径参数

参数

是否必选

取值范围

描述

domain_id

最大长度:64

客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

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/transfer-amount?balance_type=BALANCE_TYPE_DEBIT  HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

状态码。具体请参考状态码。只有失败才会返回这个参数。

error_msg

String

最大长度:1024

错误描述信息。只有失败才会返回这个参数。

totalCount

Integer

-

记录条数。

amountInfo

List<TransferAmountInfo>

-

可拨款余额信息,如果是余额账户,只会有一条记录。

具体请参见表3

表3 AmountInfo

参数

参数类型

取值范围

描述

availTransferAmount

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。

仅账户类型(balance_type)=信用账户时才有这个字段。

如果查询信用账户可拨款余额的查询结果没有失效时间,表示永久有效。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  

{
    "totalCount": 1,
    "amountInfo": [
        {
            "availTransferAmount": 2.19,
            "measureId": 1,
            "currency": "CNY",
            "amount": null,
            "creditAmount": null,
            "expireTime": null
        }
    ]
}

状态码

  • 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
  • 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

400

CBC.99000047

账户不存在。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品