全部产品
云市场

账户代金券查询接口

更新时间:2018-08-17 11:28:10

接口名

QueryCashCoupons

描述

查询用户代金券信息。

请求参数

名称 类型 是否必填 说明
Action String 要执行的操作,取值:QueryCashCoupons
EffectiveOrNot Boolean 代金券是否生效。取值范围:True,False
ExpiryTimeStart String 失效时间起,格式:yyyy-MM-dd’T’HH:mm:ss’Z’,样例:2018-08-01T00:00:00Z
ExpiryTimeEnd String 失效时间起,格式:yyyy-MM-dd’T’HH:mm:ss’Z’,样例:2018-08-01T00:00:00Z

返回参数

名称 类型 说明
CashCouponId String 代金券ID
CashCouponNo String 代金券编码
GrantedTime String 发放时间
EffectiveTime String 生效时间
ExpiryTime String 失效时间
NominalValue String 面额
Balance String 剩余金额
ApplicableProducts String 适用产品(描述)
ApplicableScenarios String 适用场景(描述)
Status String Available:有效,Expired:过期,Cancelled:作废

错误码

错误码 错误信息 HTTP状态码语义
NotApplicable This API is not applicable for caller. 400 该用户没有访问API的权限。
MissingParameter The specified parameter xx is mandatory for this request. 400 指定的参数未设置。
InvalidParameter The specified moduleCode is not valid. 400 指定的参数不合法。
InternalError The request processing has failed due to some unknown error, exception or failure. 400 内部未知错误。

请求示例

  1. https://business.aliyuncs.com/?Action=QueryCashCoupons
  2. &EffectiveOrNot=True
  3. &ExpiryTimeEnd=2019-09-01T00%3A00%3A00Z
  4. &ExpiryTimeStart=2018-08-01T00%3A00%3A00Z
  5. &公共参数

返回示例

  1. "Data": {
  2. "CashCoupon": [
  3. {
  4. "Status": "Available",
  5. "CashCouponNo": "Q-b1485def8f04a",
  6. "ApplicableProducts": "通用",
  7. "CashCouponId": 211712502303,
  8. "NominalValue": "100.00",
  9. "ApplicableScenarios": "阿里云按量付费账单,阿里云新购",
  10. "Balance": "100.00",
  11. "ExpiryTime": "2019-01-29T15:15:50Z",
  12. "EffectiveTime": "2018-08-02T15:15:50Z",
  13. "GrantedTime": "2018-08-02T15:15:50Z"
  14. }
  15. ]
  16. }