依据卡号或券号或券动态码查询卡/券的详细信息。
method: allinpay.shopoint.couponService.couponQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
couponNo |
String |
是 |
|
卡号或券号或券动态码 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
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 - 已核销 |
|
|
unusableReason |
String |
否 |
|
不可使用的原因 |
Status不为0是有描述 |
|
|
hasPassword |
Boolean |
是 |
|
是否有密码 |
True或false |
|
|
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
couponType=3满减券时有效 |
|
|
usableMaxNum |
Integer |
否 |
|
每笔订单最多使用多少张 |
couponType=3满减券时有效 |
|
|
instruction |
String |
否 |
|
券使用须知 |
|
|
请求示例
{"couponNo":"10000000000001607134"}
响应示例
{
"code":0,
"data":{
"usableMaxNum": 2147483647,
"couponName": "500元现金卡",
"couponNo": "83000100000000098812",
"hasPassword": true,
"templateId": 398,
"validityEndDate": "2019-11-30 23:59:59",
"unusableReason": "失效",
"validityBeginDate": "2019-11-03 00:00:00",
"validityType": 0,
"balance": 0.00,
"couponType": 0,
"instruction": 11,
"initAmount": 500.00,
"status": 6
}, "sign":"ZPQxY0s/b0K7NCq18V98JFgOpP5hRbQbjPY+4yduQaaDIyPAwAhaYBXZDzs30dndHeR9e35Gs7vSE+v4ZVsAgv1nSdFHEjGzf3DN 8iMKjOy5emtxLtyNZTrCrCKvSlbwTGhK/eFlQ2WlcobFFzZrZvKwgUGrO13Ng8M7AYOQ23g="
}