通过该接口查询原订单的发卡/券及卡/券领取、使用情况。
method: allinpay.shopoint.couponService.couponSendQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
tranNo |
String |
否 |
|
发券凭证（流水号） |
tranNo和sendCouponOrderId二选一，二者都填时只用tranNo |
|
sendCouponOrderId |
String |
否 |
|
发券时的外部发券订单号 |
tranNo和sendCouponOrderId二选一，二者都填时只用tranNo |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
否 |
|
错误信息 |
接口失败时提示 |
||
|
data |
send |
Boolean |
是 |
|
是否领取 |
true：已经领取 false：未领取 |
|
|
tranNo |
String |
是 |
|
凭证号（流水号） |
|
||
|
sendCouponOrderId |
String |
否 |
|
发券时的外部发券订单号 |
|
||
|
num |
int |
否 |
|
领取数量 |
券未领取时不返回 |
||
|
couponList |
List |
否 |
|
|
券未领取时不返回 |
||
|
|
couponNo |
String |
是 |
|
券号 |
|
|
|
couponType |
int |
是 |
|
券类型 |
0 - 现金卡 2 - 计次券 3 - 满减活动券 |
||
|
balance |
BigDecimal |
是 |
|
余额 |
|
||
|
unit |
String |
是 |
|
单位 |
计次券使用 |
||
|
validityType |
Integer |
是 |
|
有效期类型 |
0 - 指定日期范围 1 - 领用之日起n天内 |
||
|
validityBeginDate |
String |
是 |
|
有效期起始日期 |
null表示不限制 |
||
|
validityEndDate |
String |
是 |
|
有效期结束日期 |
|
||
|
status |
Integer |
是 |
|
券状态 |
0 - 有效 1 - 冻结 2 - 已作废 3 - 已核销 |
||
请求示例
{"tranNo":"202103011621245731366302538756612097"}
响应示例
{ "code": 0, "data": { "couponList": [ { "balance": 100.00, "couponNo": "10000000010002488355", "couponType": 1, "status": 0, "validityBeginDate": "2021-03-01 00:00:00", "validityEndDate": "2021-03-30 23:59:59", "validityType": 1 }, { "balance": 100.00, "couponNo": "10000000010002488258", "couponType": 1, "status": 0, "validityBeginDate": "2021-03-01 00:00:00", "validityEndDate": "2021-03-30 23:59:59", "validityType": 1 } ], "num": 2, "send": true, "tranNo": "202103011625566821366303680077062146" }, "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="}