3.1 商户卡券

优质
小牛编辑
151浏览
2023-12-01

3.1 商户卡券

3.1.1发送卡券

【场景介绍】

将已创建的卡券发送给商户自己的用户,建立起卡券与用户的对应关系。

【请求地址】

环境接口服务URI
生产环境/rest/v1.0/merchant/sendCoupon

3.1.1.1请求参数

参数名称参数含义数据类型必填参数说明
merchantNo商户编号String(16)Y用户所属商户的商编
merchantUserId领券方商户用户标识String(32)Y
activeNo活动编号String(32)Y

3.1.1.2返回参数

参数名称参数定义参数说明
activeNo活动编号
couponNoList卡券编号列表
code返回码请参考附录:返回码列表
message返回消息返回码的详细说明

3.1.2领取卡券

【场景介绍】

卡券的使用需要用户先确认领取时,需要调用此接口

【请求地址】

环境接口服务URI
生产环境\/rest\/v1.0\/user\/receiveCoupon

3.1.2.1请求参数:

参数名称参数含义数据类型必填参数说明
marketNo卡券编号String(32)Y
merchantNo商户编号String(16)Y用户所属商户的商编
merchantUserId领券方商户用户标识String(32)Y

3.1.2.2返回参数:

参数名称参数定义参数说明
code返回码请参考附录:返回码列表
message返回消息返回码的详细说明

3.1.3用户未领取卡券查询

【场景介绍】

查询某个用户未领取的所有卡券列表。

重要说明: 如传入创建的卡券定义编号,则查询的是该卡券的未领取信息。

【请求地址】

环境接口服务URI
生产环境/rest/v1.0/user/queryUnReceivedCoupons

3.1.3.1请求参数:

参数名称参数含义数据类型必填参数说明
couponActiveNo卡券活动编号String(32)N非必填参数,如果不传则查询当前用户名下所有未领取卡券信息
merchantNo商户编号String(16)Y用户所属商户的商编
merchantUserId领券方商户用户标识String(32)Y

3.1.3.2返回参数:

参数名称参数定义参数说明
marketList卡券列表卡券列表说明详见下文注释
code返回码请参考附录:返回码列表
message返回消息返回码的详细说明

【卡券列表注释说明】

1、格式:Json串。

2、返回示例:

[{

"couponNo" : "AMCRP20160830111448823NpdpGrj",

"couponType" : "COUPON",

"fundType" : "NONE",

"sendMerchantNo" : "BL12345678901260",

"name" : "100000",

"value" : "0.01",

"status" : "RECEIVED",

"expireTime" : "2016-08-30 11:19:48"

}]

[{

"卡券编号" : "AMCRP20160830111448823NpdpGrj",

"卡券类型" : "COUPON",

"资金类型" : "NONE",

"发券方商户编号" : "BL12345678901260",

"活动名称" : "100000",

"面值" : "0.01",

"状态" : "RECEIVED",

"未领取卡券过期时间" : "2016-08-30 11:19:48"

}]

3、卡券状态:初始化-INIT、处理中-PROCESSING、发放中-SENDING、已退回-REFUND、已领取-RECEVIED。

4、卡券类型:卡券-COUPON。

3.1.4用户所有已领取(包括已用和未用)卡券查询

【场景介绍】

查询某个用户所有的已领取卡券,包括已使用的和未使用卡券。

【请求地址】

环境接口服务URI
生产环境/rest/v1.0/user/queryAllCoupons

3.1.4.1请求参数:

参数名称参数含义数据类型必填参数说明
merchantNo商户编号String(16)Y用户所属商户的商编
merchantUserId领券方商户用户标识String(32)Y

3.1.4.2返回参数:

参数名称参数定义参数说明
marketList卡券列表卡券列表说明详见下文注释
code返回码请参考附录:返回码列表
message返回消息返回码的详细说明

卡券列表注释说明:参考3.1.3的注释说明

3.1.5用户可用卡券查询

【场景介绍】

用户在确认支付前,查询已领取的全部可用卡券。

重要说明: 返回可用卡券列表时,按照订单金额维度,分为已领取可用和已领取不可用两个列表。

【请求地址】

环境接口服务URI
生产环境/rest/v1.0/user/queryAvailableCoupons

3.1.5.1请求参数

参数名称参数含义数据类型必填参数说明
merchantNo商户编号String(16)Y用户所属商户的商编
merchantUserId领券方商户用户标识String(32)Y
orderAmount订单金额AmountY必须大于等于0.01,最大18位
orderDate订单时间DateTimeY格式:YYYY-MM-DD HH:mm:ss
productCatalog产品类别码StringN同订单接口的商品类别码
extendMarketInfo营销扩展信息StringNJSON格式

3.1.5.2返回参数

参数名称参数定义参数说明
code返回码请参考附录:返回码列表
message返回消息返回码的详细说明
availableCouponList已领的可用卡券列表不包含未领、过期等不可用的,即卡券面值小于等于订单金额的有效卡券列表。
unAvailableCouponList已领的不可用卡券列表不包含未领、过期等不可用的,即卡券面值大于订单金额的有效卡券列表。

卡券列表注释说明:参考3.1.3的注释说明

3.1.6用户所有卡券列表查询页面

【请求地址】

环境接口服务URI
生产环境/rest/v1.0/user/getAllCouponsPage

3.1.6.1请求参数

参数名称参数含义数据类型必填参数说明
requestNo商户请求号String(32)Y
merchantNo商户编号String(16)Y
merchantUserId商户用户标识String(32)Y
webCallbackUrl页面回调地址String(512)Y实名完成后返回商户的地址
returnUrl返回地址String(512)Y钱脉第一个H5页面左上角点“返回”的回退地址
clientSource设备来源EnumYPC—PC端

3.1.6.2返回参数

参数名称参数定义参数说明
redirectUrl重定向地址跳转到钱脉卡券列表页面的地址
code返回码请参考附录:返回码列表
message返回消息返回码的详细说明