6.12查询微信代金券详情


接口地址

生产环境:

https://cus.allinpay.com/cusapi/sybserviceapi/querycoupondetail

测试环境:

https://syb-test.allinpay.com/vsppcusapi/sybserviceapi/querycoupondetail

使用场景:

通过此接口可查询代金券信息,包括代金券的基础信息、状态。如代金券已核销,会包括代金券核销的订单信息(订单号、单品信息等)

 

请求参数:

参数

参数名称

取值

可空

最大长度

备注

orgid

代理商号

 

15

代理商必填

cusid

平台商户号

 

15

 

appid

代理商应用ID

 

8

平台分配的代理商APPID

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

商户自行生成的随机字符串

32

 

sign

签名

 

32

详见安全规范

signtype

签名类型

 RSA/SM2

4

 

couponid

代金券id

 

20

微信为代金券唯一分配的id。

wxopenid

微信openid

 

 

 

 

响应参数:

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

平台商户号

 

15

 

appid

代理商应用ID

 

8

 

randomstr

随机字符串

随机生成的

字符串

32

 

sign

签名

 

32

详见安全规范

availablebegintime

可用开始时间

 

 

可用开始时间,遵循rfc3339标准格式

格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE

YYYY-MM-DD表示年月日

T出现在字符串中,表示time元素的开头

HH:mm:ss.sss表示时分秒毫秒

TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)

例如:2015-05-20T13:29:35.120+08:00

表示北京时间2015年5月20日 13点29分35秒。

availableendtime

可用结束时间

 

 

格式参考availablebegintime

createtime

领券时间

 

 

领券时间,格式参考

availablebegintime

couponid

代金券id

 

 

 

微信为代金券唯一分配的id。

couponname

代金券名称

 

 

 

代金券名称

coupontype

券类型

 

 

 

券类型:
NORMAL:满减券
CUT_TO:减至券

status

代金券状态

 

 

 

代金券状态:
SENDED:可用
USED:已实扣
EXPIRED:已过期

description

使用说明

 

 

使用说明

nocash

是否无资金流

true/false

 

 

是否无资金流

ture:是
false:否

singleitem

是否单品优惠

 

 

枚举值:
true:是
false:否

stockcreatormchid

创建批次的商户号

 

 

批次创建方商户号。

stockid

批次号

 

 

批次号

normalcouponinformation

字符串

格式如下

{ transactionminimum =面额,数字(单位:分)

couponamount =金额门槛,数字(单位分)}

 

 

普通满减券面额、门槛信息。

 

normalcouponinformation普通满减券面额、门槛信息

字段ID

字段名称

取值

可空

最大长度

备注

transaction_minimum

门槛

 

 

 

门槛

coupon_amount

面额

 

 

 

面额

 


yinjr 2024年11月5日 16:45 收藏文档