依据券号或券动态码查询卡/券的详细信息。
method: allinpay.shopoint.couponService.couponsQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
couponNos |
Array，String类型 |
是 |
|
券号或券动态码列表 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
coupons |
templateId |
Integer |
是 |
|
模板ID |
|
|
couponNo |
String |
是 |
|
券号 |
|
||
|
couponName |
String |
是 |
|
券名称 |
|
||
|
couponType |
int |
是 |
|
券类型 |
0 - 现金卡 2 - 计次券 3 - 满减活动券 |
||
|
balance |
BigDecimal |
是 |
|
余额 |
|
||
|
initAmount |
BigDecimal |
是 |
|
面额 |
|
||
|
unit |
String |
是 |
|
单位 |
计次券使用 |
||
|
validityType |
Integer |
是 |
|
有效期类型 |
0 - 指定日期范围 1 - 领用之日起n天内 |
||
|
validityBeginDate |
String |
是 |
|
有效期起始日期 |
null表示不限制 |
||
|
validityEndDate |
String |
是 |
|
有效期结束日期 |
|
||
|
status |
Integer |
是 |
|
券状态 |
0 - 有效 1 - 冻结 2 - 已作废 3 - 已核销 100 – 待生成 |
||
|
unusableReason |
String |
否 |
|
不可使用的原因 |
Status不为0是有描述 |
||
|
hasPassword |
Boolean |
是 |
|
是否有密码 |
True或false |
||
|
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
couponType=3满减券时有效 |
||
|
usableMaxNum |
Integer |
否 |
|
每笔订单最多使用多少张 |
couponType=3满减券时有效 |
||
|
instruction |
String |
否 |
|
券使用须知 |
|
||
请求示例
{"couponNos":["10000000000001607134", "10000000000001607135"]}
响应示例
[
{
"templateId": 794,
"couponNo": "10000000000001608568",
"couponName": null,
"couponType": null,
"balance": null,
"unit": null,
"validityType": null,
"validityBeginDate": null,
"validityEndDate": null
}
]