查询储值卡列表
功能介绍
客户可以查询已购买的储值卡列表。
接口约束
该接口可以使用客户AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/promotions/benefits/stored-value-cards
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
status |
是 |
Integer |
[1-2] |
状态： 1：可使用 2：已用完 |
card_id |
否 |
String |
最大长度：64 |
储值卡ID。 此参数不携带或携带值为空时，不作为筛选条件。 |
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。 |
limit |
否 |
Integer |
[1-100] |
查询的储值卡的数量，默认值为10。 |
请求消息
请求参数
无
请求示例
GET https://bss.myhuaweicloud.com/v2/promotions/benefits/stored-value-cards?status=1&card_id=userSVCId2148682091&offset=0&limit=100 HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
error_code |
String |
最大长度：16 |
状态码。 具体请参见状态码。 |
error_msg |
String |
最大长度：1024 |
错误描述信息。 |
total_count |
Integer |
- |
符合查询条件的总条数。 |
stored_value_cards |
List<UserStoredValueCard> |
- |
优惠券记录。 具体请参见表2。 |
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
card_id |
String |
最大长度：64 |
储值卡ID。 |
card_name |
String |
- |
储值卡名称。 |
status |
Integer |
- |
状态： 1：可使用 2：已用完 |
face_value |
String |
- |
储值卡面值。 |
balance |
String |
- |
储值卡余额。 |
effective_time |
String |
最大长度：20 |
生效时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 |
expire_time |
String |
最大长度：20 |
失效时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"total_count": 1,
"stored_value_cards": [
{
"card_id": "userSVCId145022729",
"card_name": "华为云储值卡10000元",
"status": 1,
"face_value": "10000.00",
"balance": "10000.00",
"effective_time": "2021-12-13T01:34:52Z",
"expire_time": "2022-07-01T01:34:52Z"
}
]
}
