查询收支明细
功能介绍
客户可以查询自身的收支明细情况。
接口约束
客户查询自身的收支明细的时候,只允许使用客户自身的AK/SK或者Token调用。
此接口不适用于伙伴的代售类、转售类客户。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/accounts/customer-accounts/account-change-records
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
balance_type |
是 |
String |
[BALANCE_TYPE_DEBIT|BALANCE_TYPE_CREDIT] |
账户类型。
|
revenue_expense_type |
否 |
String |
[REVENUE|EXPENSE] |
收支类型。
此参数不携带时,不作为筛选条件;此参数携带值不允许为空、null、空串,有枚举值校验。 |
trade_type |
否 |
String |
最大长度:20 |
交易类型。
此参数不携带、携带值为空时,不作为筛选条件;此参数携带值为null,作为筛选条件过滤;此参数不允许为空串,有正则校验。 |
trade_time_begin |
否 |
String |
最大长度:10 |
查询收支明细的开始日期。
说明:
此参数不携带、携带值为空时,不作为筛选条件;此参数不允许携带值为空串或值为null,有参数校验。 |
trade_time_end |
否 |
String |
最大长度:10 |
查询收支明细的结束日期。
说明:
此参数不携带、携带值为空时,不作为筛选条件;此参数不允许携带值为空串或值为null,有参数校验。 |
trade_id |
否 |
String |
最大长度:128 |
交易ID/订单ID。 此参数不携带、携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;此参数不允许为空串,有正则校验。 |
payment_channel_id |
否 |
String |
最大长度:64 |
交易渠道。可以一次查询多个,用逗号分隔。
此参数不携带、携带值为空时,不作为筛选条件;此参数携带值为空串或为null时,作为筛选条件过滤。 |
payment_channel_no |
否 |
String |
最大长度:64 |
交易渠道流水号。 此参数不携带、携带值为空时,不作为筛选条件;此参数携带值为null,作为筛选条件过滤;此参数不允许为空串,有正则校验。 |
offset |
否 |
Integer |
[0-最大整数] |
偏移量,从0开始。默认值为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。 此参数不携带、为null或携带值为空时,默认传参为0;此参数不允许为空串,有参数校验。 |
limit |
否 |
Integer |
[1-100] |
每次查询的数量,默认值为10。 此参数不携带时,默认传参为10;此参数不允许为空、空串或为null,有参数校验。 |
请求消息
请求参数
无
请求示例
GET https://bss.myhuaweicloud.com/v2/accounts/customer-accounts/account-change-records?balance_type=BALANCE_TYPE_DEBIT&trade_type=RECHARGE&trade_time_begin=2020-10-20&trade_time_end=2021-10-20&offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:20 |
状态码。具体参见状态码。只有失败才会返回这个参数。 |
error_msg |
String |
最大长度:2000 |
错误描述信息。只有失败才会返回这个参数。 |
total_count |
Integer |
- |
返回总条数。 |
currency |
String |
最大长度:4 |
币种。 CNY:人民币。 |
records |
List<CustomerAccountChangeRecord> |
- |
收支明细记录列表。 具体请参见表2。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
account_change_id |
String |
最大长度:128 |
收支明细流水号。 |
trade_detail_type |
String |
最大长度:128 |
交易详细类型。
|
trade_time |
String |
最大长度:20 |
交易时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2016-03-28T14:45:38Z”。 |
trade_id |
String |
最大长度:128 |
交易ID/订单ID。 |
change_amount |
String |
最大长度:64 |
变更金额,单位为元。 |
balance_after_change |
String |
最大长度:64 |
变更后余额,单位为元。 |
revenue_expense_type |
String |
最大长度:64 |
收支类型。
|
bill_cycle |
String |
最大长度:7 |
账期。 |
payment_channel_id |
String |
最大长度:128 |
交易渠道。
|
payment_channel_no |
String |
最大长度:128 |
交易渠道流水号。 |
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 1, "currency": "CNY", "records": [ { "account_change_id": "AC-8500000373-0", "trade_detail_type": "SOURCE_OPERAIION_RECHARGE", "trade_time": "2021-04-02T06:05:38Z", "trade_id": "CB123456", "change_amount": "1053.35", "balance_after_change": "0.00", "revenue_expense_type": "REVENUE", "bill_cycle": "2018-08", "payment_channel_id": "4", "payment_channel_no": "AC6780*****73-0" } ] }