3.2卡券营销

3.2.1卡/券查询

依据卡号或券号或券动态码查询卡/券的详细信息。

 

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="

}

 

3.2.2发卡/券

产生卡/券

 

method: allinpay.shopoint.couponService.couponSend

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
shopId	String	否		店铺ID
shopCode	String	否		店铺号	与shopId功能相同，shopId和shopCode同时输入则只取shopId，shopId和shopCode必输一项
operUserId	String	是		收银员id	收银员登录名称
couponType	String	是		券类型	1-电子券 2-纸质券
num	String	是		发券数量	正整数
couponTemplateId	String	是		券模板Id
idType	String	否		接受券的会员账号类型	1- 手机号 2- 会员卡号 3- Openid 5-外部ID
memberId	String	否		接受券的会员账号	idType存在时必填 Openid不能被查询到时，将新建对应的用户
orderId	String	是		外部发券订单号
sourceType	String	否		来源类型	1- 手机号 2- Openid 3- 导购ID 4- 用户ID
sourceValue	String	否		来源值 来源类型（sourceType）存在时必填
remark	String	否		备注信息
extendInfo	JSON	否		自定义扩展信息	如： extendInfo: { "buyerType": "个人", "buyerIdNo": "51*****217", "buyerContact": "189***25", }
buyerMobile	String	否		购卡人手机号	多用途金额券或者实体卡为记名卡或者批次金额超过10000元时必填 需先调用会员实名接口

 

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data	tranNo		String	是		流水号
	shopName		String	是		店铺名称
	tranDateTime		String	是		交易时间
	instruction		String	否		券使用须知
	list			是		交易券明细
		templateId	Integer	是		模板ID
		couponName	String	是		券名称
		couponNo	String	否		券号	发券对象，或纸质券时有效
		qrCodeContext	String	否		电子券二维码	无发券对象，且电子券时有效

 

请求示例

{"shopId":"1","operUserId":"1","couponType":"1","num":"10","couponTemplateId":"307"}

响应示例

{

    "code": 0,

    "data": {

        "tranNo": "50806050005080208145",

        "shopName": null,

        "tranDateTime": [

            2020,

            4,

            10,

            16,

            3,

            49

        ],

        "list": [

            {

                "templateId": 307,

                "couponName": "专门测试ZHT",

                "couponNo": null,

                "qrCodeContext": "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQF48DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyNDdIQUo1VEw5X1AxeFJTZ051Y0IAAgRlKJBeAwQQDgAA"

            }

        ]

    },

    "sign": "VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

 

}

3.2.4卡/券作废

根据券号作废卡/券。

method: allinpay.shopoint.couponService.couponCancel

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
cancelType	String	是		作废券原因 发券全额撤销只能作废未使用过的卡/券	1- 发券全额撤销 2- 人工退款退券
couponNo	String	是		券号
orderId	String	是		废券订单号

 

业务响应参数

字段名	参数类型	必填	说明	取值
code	Integer	是	返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg	String	否	错误信息
data	Boolean	是		true

 

请求示例

{"cancelType":"1","couponNo":”83000100040000007485”,"orderId":"1111122222"}

响应示例

{

    "code": "0",

    "data": "true",

"sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4FdJ7    lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

3.2.5卡/券核券撤销

根据核销订单号撤销核券操作，将核券订单全部退回核券前。

method: allinpay.shopoint.couponService.couponConsumeCancel

version: 1.0

业务请求参数

 

字段名		参数类型	必填	最大长度	说明	取值
consumeOrderId		String	是		核券订单号
orderId		String	是		外部核券撤销订单号
shopId		String	否		店铺ID	店铺ID必须与核销时的店铺一致； 店铺ID和店铺号必输一项
shopCode		String	否		店铺号	店铺号必须与核销时的店铺一致； 店铺ID和店铺号必输一项
operUserId		String	是		收银员id	收银须具有对应店铺的操作权限
couponConsumeList					否	验券部分撤销列表（仅支持金额券）
	couponNo	String	是		券号或券动态码
	consumeAmount	String	是		金额券单位：元
	remark	String	否		备注
	stlmShopList	List	否		结算店铺信息
	stlmShopId	Integer	否		结算店铺id
	stlmShopCode	String	否		结算店铺号
	stlmAmount	Decimal	否		结算金额, 单位元

 

业务响应参数

字段名	参数类型	必填	说明	取值
code	Integer	是	返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg	String	是	错误信息
data	Boolean	是		true

 

请求示例

{"consumeOrderId":"222222211111","orderId":"1111122222","=shopId":"1","operUserId ":"1","passwd":"6E5C47F095BB6DC3308A89514A7206C8"}

响应示例

{

    "code": 0,

    "data": true,

  "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

3.2.7发卡/券(套券)

产生卡/券。

 

method: allinpay.shopoint.couponService.couponSendList

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
shopId	String	否		店铺ID
shopCode	String	否		店铺号	与shopId功能相同，shopId和shopCode同时输入则只取shopId，shopId和shopCode必输一项
operUserId	String	是		收银员id	收银员登录名称
couponType	String	是		券类型	1-电子券 2-纸质券
num	String	是		发套券数量	正整数
promotionId	String	是		活动Id
idType	String	否		接受券的会员账号类型	1-手机号 2-会员卡号 3-Openid 5-外部ID
memberId	String	否		接受券的会员账号	idType存在时必填 Openid不能被查询到时，将新建对应的用户
orderId	String	是		外部发券订单号
sourceType	String	否		来源类型	1-手机号 2-Openid 3-导购ID 4-用户ID
sourceValue	String	否		来源值 来源类型（sourceType）存在时必填
remark	String	否		备注信息

 

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data	tranNo		String	是		流水号
	shopName		String	是		店铺名称
	tranDateTime		String	是		交易时间
	list			是		交易券明细
		instruction	String	是		券使用须知
		couponName	String	是		券名称
		couponNo	String	否		券号	发券对象，或纸质券时有效
		qrCodeContext	String	否		电子券二维码	无发券对象，且电子券时有效

 

请求示例

{"shopId":"1","operUserId":"1","couponType":"1","num":"10","couponTemplateId":"307"}

响应示例

{

    "code": 0,

    "data": {

        "tranNo": "50806050005080208145",

        "shopName": null,

        "tranDateTime": [

            2020,

            4,

            10,

            16,

            3,

            49

        ],

        "list": [

            {

                "templateId": 307,

                "couponName": "专门测试ZHT",

                "couponNo": null,

                "qrCodeContext": "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQF48DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyNDdIQUo1VEw5X1AxeFJTZ051Y0IAAgRlKJBeAwQQDgAA"

            }

        ]

    },

    "token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"

}

 

3.2.8发卡/券查询

通过该接口查询原订单的发卡/券及卡/券领取、使用情况。

 

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="} 

 

3.2.9作废发卡/券

通过发券凭证号（流水号）将未领取的卡/券作废(能且仅能作废成功一次)。

 

method: allinpay.shopoint.couponService.couponSendCancel

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
tranNo	String	是		发券凭证（流水号）

业务响应参数

字段名	参数类型	必填	说明	取值
code	Integer	是	返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg	String	否	错误信息
data	Boolean	是		true

 

请求示例

{"tranNo":"202103011621245731366302538756612097"}

响应示例

{    "code": 0,    "data": true,    "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="}

 

3.2.10卡/券充值

支持卡/券充值。

 

method: allinpay.shopoint.couponService.cardRecharge

version: 1.0

业务请求参数

字段名	字段名	参数类型	必填	最大长度	说明	取值
orderId		String	是	60	外部充值订单号
reChargeType		Integer	是	11	充值类型	0-现金卡 2-计次卡
cardRechargeList		List	是		充值列表
	cardNo	String	是	32	实体卡卡号
	value	String	是	11	充值数量	现金卡充值：单位元 计次充值：单位次

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	否		错误信息
data	records		List	是		充值明细列表
		reChargeType	Integer	是		充值类型	0-现金卡 2-计次卡
		cardNo	String	是		实体卡卡号
		couponName	String	是		券名称
		balanceChanged	BigDecimal	是		充值数量(对应充值接口的value)	单位元-现金卡 单位次-计次卡
		initAmount	BigDecimal	是		初始面额	单位元-现金卡 单位次-计次卡
		balance	BigDecimal	是		充值后余额	单位元-现金卡 单位次-计次卡
		validityBeginDate	String	是		有效期起始日期
		validityEndDate	String	是		有效期截止日期
		rechargeStatus	Integer	是		处理状态	0-待处理 1-处理成功 2-处理失败 3-审核拒绝
		rechargeStatusDesc	String	是		处理状态描述	0-待处理 1-处理成功 2-处理失败 3-审核拒绝
		failDesc	String	否		失败原因
		rechargeTime	String	是		充值时间	时间格式:yyyy-dd-MM HH:mm:ss
		requestor	String’	是		操作员(充值申请人)	接口充值为:接口导入
		auditor	String	是		充值审批人

 

请求示例

{"orderId":"20210914001","reChargeType":"0","cardRechargeList":[{"cardNo":"202105120000001","value":"6"}]}

响应示例

{

"code": "0",

"data": "[{"couponName":"金额券0元0512001","rechargeStatus":1,"auditor":"接口导入","rechargeTime":"2021-09-14 10:02:14","cardNo":"202105120000001","validityEndDate":"2021-09-30 23:59:59","requestor":"接口导入","reChargeType":0,"validityBeginDate":"2021-05-12 00:00:00","balance":6.00,"rechargeStatusDesc":"处理成功","initAmount":0,"balanceChanged":6.0000}]",

"sign": "cS/NJZo1+eUyLdeFzeFj8ZpiZtYL6R+lbMuSqYGVPaAuikHIx71UGkq0KdOxKFYctBRTjFG9s85GGSf7oq1BjIsUYoVUC+9nNANfGgF1UpzRngkyD0PBboCiM0v0zvd4pP3ishKhprSXdupNfREUwYjWq5NLO9F9gWf7tXK/7sA="

}

3.2.11卡/券充值查询

支持卡/券充值结果查询。

 

method: allinpay.shopoint.couponService.cardRechargeQuery

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
orderId	String	是	60	外部充值订单号

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	否		错误信息
data	records		List	是		充值明细列表
		reChargeType	Integer	是		充值类型	0-现金卡 2-计次卡
		cardNo	String	是		实体卡卡号
		couponName	String	是		券名称
		balanceChanged	BigDecimal	是		充值数量(对应充值接口的value)	单位元-现金卡 单位次-计次卡
		initAmount	BigDecimal	是		初始面额	单位元-现金卡 单位次-计次卡
		balance	BigDecimal	是		充值后余额	单位元-现金卡 单位次-计次卡
		validityBeginDate	String	是		有效期起始日期
		validityEndDate	String	是		有效期截止日期
		rechargeStatus	Integer	是		处理状态	0-现金卡 2-计次卡
		rechargeStatusDesc	String	是		处理状态描述	0-待处理 1-处理成功 2-处理失败 3-审核拒绝
		failDesc	String	否		失败原因
		rechargeTime	String	是		充值时间	时间格式:yyyy-dd-MM HH:mm:ss
		requestor	String’	是		操作员(充值申请人)	接口充值为:接口导入
		auditor	String	是		充值审批人

 

请求示例

{"orderId ":"122212132323231231"}

响应示例

{

"code": "0",

"data": "[{"couponName":"金额券0元0512001","rechargeStatus":1,"auditor":"接口导入","rechargeTime":"2021-09-14 10:02:14","cardNo":"202105120000001","validityEndDate":"2021-09-30 23:59:59","requestor":"接口导入","reChargeType":0,"validityBeginDate":"2021-05-12 00:00:00","balance":6.00,"rechargeStatusDesc":"处理成功","initAmount":0,"balanceChanged":6.0000}]",

"sign": "cS/NJZo1+eUyLdeFzeFj8ZpiZtYL6R+lbMuSqYGVPaAuikHIx71UGkq0KdOxKFYctBRTjFG9s85GGSf7oq1BjIsUYoVUC+9nNANfGgF1UpzRngkyD0PBboCiM0v0zvd4pP3ishKhprSXdupNfREUwYjWq5NLO9F9gWf7tXK/7sA="

}

 

3.2.12实体储值卡激活（单张）

method: allinpay.shopoint.couponService.cardActive

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
cardNo	String	是	32	实体卡卡号
operUserId	String	是	30	收银员id	收银员登录名称
extendInfo	JSON	否	含格式，不超过1000	自定义扩展信息	如： extendInfo: { "buyerType": "个人", "buyerIdNo": "51*****217", "buyerContact": "189***25", }
buyerMobile	String	否	11	购卡人手机号	多用途金额券或者实体卡为记名卡或者批次金额超过10000元时必填 需先调用会员实名接口

业务响应参数

字段名		参数类型	必填	说明	取值
code		Integer	是	返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg		String	否	错误信息
data	cardNo	String	是	实体卡卡号
	couponType	Integer	是	券类型	0-金额券、2-计次券
	finishTime	String	是	到账时间	格式：yyyy-MM-dd HH:mm:ss
	templateId	Integer	是	券模板ID
	initAmount	BigDecimal	是	初始面额	单位元-现金卡 单位次-计次卡
	balance	BigDecimal	是	余额	单位元-现金卡 单位次-计次卡

 

请求示例

{"cardNo":"122212132323231231",”operUserId”,”1”}

响应示例

{

    "code": 0,

    "data": {

        "cardNo": “121222432432412”,

        "couponType": 0,

        "finishTime": “2021-09-11 11:11:11”,

        "templateId": 1,

        "initAmount": 100,

          "balance": 100,

    },

    "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

3.2.13可发卡/券列表查询(套)

依据收银员账号查询可发券列表信息。

method: allinpay.shopoint.couponService.couponCanSendListNew

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
userId	String	是		用户账号

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data			List			可发券列表
	orgId		Integer	是		机构ID
	activityId		Integer	是		发券活动ID
	activityName		String	是		发券活动名称
	beginTime		String	是		发放开始时间
	endTime		String	是		发放结束时间
	maxNum		Integer	是		库存	0表示不限制
	sentCount		Integer	是		已发数量
	receivedCount		Integer	是		已领数量
	status		Integer	是		是否启用	0-停用 1-启用
	couponTemplateItemList		List	是		券模板列表
		templateId	Integer	是		模板ID
		couponName	String	是		券名称
		couponType	int	是		券类型	0-现金卡 1-代金券 2-计次券 3-满减活动券
		sendNum	Integer	是		该券模版发几张
		initAmount	Integer	是		余额	初始金额、次数, 单位：分
		unit	String	否		单位	计次券时返回
		validityType	Integer	是		有效期类型	0 - 指定日期范围 1 - 领用之日起n天内
		validityBeginDate	String	否		有效期起始日期	null表示不限制 validityType=0返回
		validityEndDate	String	否		有效期结束日期
		validityDays	Integer	否		领用之日起多少天内有效	validityType=1返回
		validityBeginDays	Integer	否		领用后多少天后生效
		rangeDate	Integer	否		可用日期,NULL表示不限制，否则解析字符串获取。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。
		rangeDayOfWeek	Integer	否		每周几可用。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。
		rangeTime				每天哪些时段可用,NULL表示不限制，否则解析字符串获取设定规则 示例： 9:30~10:30,17:00~19:00
		usableAmount	BigDecimal	否		每满多少金额可以使用1张	couponType=3满减券时有效
		usableMaxNum	Integer	否		每笔订单最多使用多少张	couponType=3满减券时有效
		instruction	String	否		券使用须知

请求示例

{”userId”:”123”}

响应示例

{

"code": "0",

"data": [{

"activityId": 186,

"couponTemplateItemList": [{

"rangeDate": 2147483647,

"usableMaxNum": 2147483647,

"couponName": "发券测试0908",

"validityType": 1,

"couponType": 0,

"instruction": "123",

"validityBeginDays": 0,

"initAmount": 100,

"sendNum": 1,

"templateId": 1323,

"validityDays": 10

}],

"activityName": "pos接口发券测试",

"receivedCount": 1,

"beginTime": "2021-03-02 00:00:00",

"endTime": "2021-04-30 23:59:59",

"maxNum": 100,

"orgId": 100038,

"sentCount": 2,

"status": 1

}],

"sign":"fQ0OPoOVA6FJJZid6QfKm+0dXUQ6ZktdeP9PsQTtlliaco1omTKSxzmKwjvlds6qM3wLd4VzKCCB1Sk1YNL2sbTvNXRqFCwQee87 PrHqKcH6hQekge440ak2IvmrVfkUo9IVyMbCUOO46Ok8eEYLfEXJUilgbQho+J4SRxeVnQo="

}

3.2.14卡/券批量查询

依据券号或券动态码查询卡/券的详细信息。

 

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

            }

]

3.2.15卡/券鉴权

根据券号或者动态码确定是否有效卡券。

method: allinpay.shopoint.couponService.couponsAuth

version: 1.0

业务请求参数

字段名		参数类型	必填	最大长度	说明	取值
coupons		List	是		验券列表
	couponNo	String	是		券号或券动态码
	passwd	String	否		密码	券动态码及没密码时可为空串,加密传输（详见2.3.4）

 

业务响应参数

字段名				参数类型	必填	最大长度	说明	取值
code				Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg				String	是		错误信息
data	coupons			List	是		验券交易详情
		couponNo		String	是		传入的券号或者动态二维码
		result		Boolean	是		鉴权结果	True, 鉴权成功 False, 鉴权失败
		failReason		String	否		鉴权失败原因

 

请求示例

{coupons":[{"couponNo":"10000000010000055943","passwd":"加密传输（详见2.3.4）"}]}

响应示例

{

    "code": 0,

    "data": {

        "coupons": [

            {

                "couponNo": "10000000000001608568",

                "result": True

            },

    "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

 

3.2.16卡/券动态二维码生成

依据券号或券动态码查询卡/券的详细信息。

 

method: allinpay.shopoint.couponService.couponQRCode

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
couponNo	String	是		卡券号

业务响应参数

字段名		参数类型	必填	最大长度	说明	取值
code		Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg		String	是		错误信息
data	couponNo	String	是		传入的券号
	qrcode	String	是		券动态二维码
	expiretime	String	是		动态二维码过期时间	格式：yyyyMMddHHmmss

请求示例

{"couponNo":"10000000000001607134"}

响应示例

{

    "code": 0,

    "data": {

        "couponNo": "10000000000001608568",

        "qrcode": "SC:323932023232",

        "expiretime": "20210701101800",

            }

    "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

 

3.2.17卡/券转赠

根据券号转赠卡券。

method: allinpay.shopoint.couponService.couponsTransfer

version: 1.0

业务请求参数

字段名		参数类型	必填	最大长度	说明	取值
coupons		List	是		验券列表
	couponNo	String	是		券号或券动态码
	passwd	String	否		密码	券动态码及没密码时可为空串,加密传输（详见2.3.4）
idType		String	是		接受券的会员账号类型	1 - 手机号 2 - 会员卡号 3 - 微信openId 4 - 动态码 5 - 外部ID 6 - 内部会员ID
memberId		String	是		接受券的会员账号	idType存在时必填

 

业务响应参数

字段名				参数类型	必填	最大长度	说明	取值
code				Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg				String	是		错误信息
data	coupons			List	是		验券交易详情
		couponNo		String	是		传入的券号或者动态二维码
		result		Boolean	是		鉴权结果	True, 鉴权成功 False, 鉴权失败
		failReason		String	否		鉴权失败原因

 

请求示例

{coupons":[{"couponNo":"10000000010000055943","passwd":"加密传输（详见2.3.4）"}]}

响应示例

{

    "code": 0,

    "data": {

        "coupons": [

            {

                "couponNo": "10000000000001608568",

                "result": True

            },

    "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4 FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

 

3.2.18卡/券发放查询

针对3.2.2产生卡/券接口的查询。

 

method: allinpay.shopoint.couponService.couponSendResultQuery

version: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
orderId	String	是	60	发卡/券订单号

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data	orderId		String	否		发卡/券订单号
	tranNo		String	否		流水号
	tranDateTime		String	否		交易时间
	instruction		String	否		券使用须知
	list			否		交易券明细
		templateId	Integer	是		模板ID
		couponName	String	是		券名称
		couponNo	String	否		券号	发券对象，或纸质券时有效
		qrCodeContext	String	否		电子券二维码	无发券对象，且电子券时有效

请求示例

{"orderId ":"122212132323231231"}

响应示例

{

"code": "0",

"data": {

"tranDateTime": "2020-12-25 17:28:12",

"instruction": "0.5元代金券，互斥，可用店铺1，无初始密码",

"tranNo": "202012251728120201342401748086394881",

"list": [{

"couponName": "test代金券0.5元互斥",

"qrCodeContext": "",

"qrCodeUrl": "",

"couponNo": "83000100030000010828",

"templateId": 136

}]

},

"sign":"SlEsBkCjU6kIDgtN1922V8WLAZokNsq61pD4Wwa0V+RJ6l/7PGQ2c9jT+ZqHN0pXt/TRzaI342KhnvaDOoC3oSGsI4HpHz1qGRqtvMlskCqk25omx0mkoshKKtIS+gjtD2vr8LYxWcaUwU/5fjn98D0uZ55GR+N4wMOj11Ccdb4="

}

3.2.19卡/券核销查询

针对3.2.3卡/券核销接口的查询。

 

method: allinpay.shopoint.couponService.couponConsumeQuery

version: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
orderId	String	是	60	卡/券核销订单号

业务响应参数

字段名				参数类型	必填	最大长度	说明	取值
code				Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg				String	是		错误信息
data	orderId			String	否		卡/券核销订单号
	orgName			String	否		机构/商户名称
	tranNo			String	否		交易流水号
	couponConsumeDetail			List	否		验券交易详情
		couponNo		String	是		券号
		consumeAmount		String	是		核销金额

请求示例

{"orderId ":"20210624001"}

响应示例

{

    "code": "0",

    "sign": "Buq7Fh3BHEIDk9M6Kt/GedVw9t1kydQdQXBKvVX1dRYsBcaZtnBRjZXNIAyM0o0dHO1vifwfMtEAjEG 0IWquatT2a8U/P+be3TaB5z9t5AzrPQC3DG8FJbQb8AGHSVYXJbDQUX2g2GQz6uNf5zWiPecMcT8sZIs8IJ14irHlo9c="

}

 

3.2.20卡/券核销撤销查询

针对3.2.5卡/券核销撤销接口的查询。

 

method: allinpay.shopoint.couponService.couponConsumeCancelQuery

version: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
orderId	String	是	60	卡/券核销订单号

业务响应参数

字段名				参数类型	必填	最大长度	说明	取值
code				Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg				String	是		错误信息
data	orderId			String	否		卡/券核销订单号
	orgName			String	否		机构/商户名称
	tranNo			String	否		交易流水号
	couponConsumeDetail			List	否		验券交易详情
		couponNo		String	是		券号
		consumeAmount		String	是		核销金额

请求示例

{"orderId ":"20210624001"}

响应示例

{

    "code": "0",

    "sign": "Buq7Fh3BHEIDk9M6Kt/GedVw9t1kydQdQXBKvVX1dRYsBcaZtnBRjZXNIAyM0o0dHO1vifwfMtEAjEG0IWquatT2a8U/P+b e3TaB5z9t5AzrPQC3DG8FJbQb8AGHSVYXJbDQUX2g2GQz6uNf5zWiPecMcT8sZIs8IJ14irHlo9c="

}

 

 

 

3.2.21卡/券模板详情查询

method: allinpay.shopoint.couponService.couponTemplateQuery

version: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
templateId	Integer	是	60	券模板id

业务响应参数

字段名		参数类型	必填	最大长度	说明	取值
code		Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg		String	是		错误信息
data	templateId	Integer	是		券模板id
	couponType	Integer	是		券类型	0-现金卡 2-计次券 3-满减活动券
	couponName	String	是		券名称
	initAmount	Integer	是		初始金额	单位: 分
	unit	String	否		单位	计次券
	validityType	Integer	是		有效期类型	0 - 指定日期范围 1 - 领用之日起n天内
	validityBeginDate	String	否		有效期起始日期	validityType=0返回
	validityEndDate	String	否		有效期结束日期
	validityBeginDays	Integer	否		领用后多少天后生效	validityType=1返回
	validityDays	Integer	否		领用之日起多少天内有效
	rangeDate	Integer	否		可用日期	NULL表示不限制，否则解析字符串获取设定二级制位表示b0 - 1 号 b1 - 2号。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。
	rangeDayOfWeek	Integer	否		每周几可用	通过对应的bit来确定是否允许，整个数字为255则表示不限 b0 - 周日 b1 - 周一 b2 - 周二 b3 - 周三 b4 - 周五 b5 - 周六。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。
	rangeTime	String	否		每天哪些时段可用	NULL表示不限制，否则解析字符串获取设定规则 示例： 9:30~10:30,17:00~19:00
	usableAmount	String	否		每满多少金额可以使用1张	满减券使用
	usableMaxNum	Integer	否		每笔订单最多使用多少张	满减券使用, 0表示不限制
	instruction	String	否		券使用须知

请求示例

{"templateId ": 398"}

响应示例

{

"code": "0",

"data": {

    "rangeDate": 2147483647,

"validityBeginDate": "2019-11-03 00:00:00",

"usableMaxNum": 2147483647,

"couponName": "500元现金卡",

"validityType": 0,

"couponType": 0,

"instruction": "11",

"validityBeginDays": 0,

"initAmount": 50000,

"templateId": 398,

"validityEndDate": "2019-11-30 23:59:59",

"validityDays": 0

},

"sign": "CTcDJQoQFqWT9VnDVY7my91O+JR4YlUviosnzg/zSRQ62 +f9XHk1tJIGC19dB1IFEGon3I6DzpC6iE8455Z5 +iJHI/FKknSmpCsoz2Gw+oj8V6gA9wv5YhLdYzuyG7o7fNpGfDqpye7UNavASRYSIM8ory92pJHb1Qk4d CvDSjw="

}

 

3.2.22 卡/券交易流水查询

method: allinpay.shopoint.couponService.changeQuery

version: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
idType	String	是		会员账号类型	1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 5- 外部会员ID 6- 内部会员ID
memberId	String	是		会员账号	根据idType来取值
pageNo	Integer	否		页码	不填默认1, 最小为1,最大为100 不在范围内则被重置为默认值
pageSize	Integer	否		每页大小	不填默认20,最小为1,最大为200 不在范围内则被重置为默认值
couponNo	String	否	32	券号	最长32位, 超出会被截去
createTimeStart	String	否		交易时间开始	格式yyyy-MM-dd HH:mm:ss, 例:2006-01-02 15:04:05 取值范围为三年前到当前时间, 不填默认三个月前
createTimeEnd	String	否		交易时间结束	格式yyyy-MM-dd HH:mm:ss, 例:2006-01-02 15:04:05 取值范围为三年前到当前时间, 不填默认当前时间

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data	total		Integer	是		总数	交易流水总条数
	pageNo		Integer	是		分页页码
	pageSize		Integer	是		分页大小
	resultList		List	否		流水分页
		templateId	Integer	是		券模板id
		couponNo	String	是		券号
		couponName	String	是		券名称
		couponType	Integer	是		券类型	0-金额券,2-计次券,3-满减券
		changeId	Integer	是		变更记录id
		changeSource	Integer	是		变更来源	30-码牌订单核券 31-POS订单核券 32-商城订单核券 33-收银宝码牌订单核券 34-POS直接核券 35-导购核券 42-开放接口核券 311-订单撤销 312-开放接口撤销
		balanceChanged	Integer	是		变更数值	单位:分
		newBalance	Integer	是		变更后的余额	单位:分
		createTime	String	是		变更时间	格式yyyy-MM-dd HH:mm:ss
		tranNo	String	否		流水号
		shopId	Integer	否		店铺ID
		remark	String	否		备注
		createUserId	Integer	是		变更人id
		createUserLoginName	String	是		变更人登录名

请求示例

{

    "idType": "1",

    "memberId": "13220830001",

    "pageNo": "1",

    "pageSize": "10",

    "couponNo": "83000100000000055331",

    "createTimeStart": "2022-08-26 14:00:00",

    "createTimeEnd": "2022-08-26 17:00:00"

}

响应示例

{

    "total": 2,

    "pageNo": 1,

    "pageSize": 10,

    "resultList": [

        {

            "changeSource": 311,

            "couponName": "lq121401",

            "createUserId": 358,

            "createTime": "2022-08-26 14:41:02",

            "couponType": 0,

            "newBalance": 400,

            "couponNo": "83000100000000055331",

            "changeId": 272525,

            "shopId": 147,

            "templateId": 6244620,

            "balanceChanged": 400,

            "createUserLoginName": "hl导购"

        },

        {

            "changeSource": 31,

            "couponName": "lq121401",

            "createUserId": 358,

            "createTime": "2022-08-26 14:39:16",

            "couponType": 0,

            "newBalance": 0,

            "couponNo": "83000100000000055331",

            "changeId": 272522,

            "shopId": 147,

            "templateId": 6244620,

            "balanceChanged": -400,

            "createUserLoginName": "hl导购"

        }

    ]

}

 

3.2.23储值卡调账

支持现金卡, 计次卡, 电子券调账。

 

method: allinpay.shopoint.couponService.cardAdjust

version: 1.0

业务请求参数

字段名	字段名	参数类型	必填	最大长度	说明	取值
orderId		String	是	60	外部调账订单号
adjustType		Integer	是	11	调账类型	0-现金卡 2-计次卡
cardAdjustList		List	是		调账列表
	cardNo	String	是	32	实体卡卡号
	value	String	是	11	调账数量	现金卡调账：单位元，2位小数 计次调账：单位次，正数

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	否		错误信息
data	records		List	是		调账明细列表
		adjustType	Integer	是		调账类型	0-现金卡 2-计次卡
		cardNo	String	是		实体卡卡号
		couponName	String	是		券名称
		balanceChanged	BigDecimal	是		调账数量(对应调账接口的value)	单位元-现金卡 单位次-计次卡
		initAmount	BigDecimal	是		初始面额	单位元-现金卡 单位次-计次卡
		balance	BigDecimal	是		调账后余额	单位元-现金卡 单位次-计次卡
		validityBeginDate	String	是		有效期起始日期
		validityEndDate	String	是		有效期截止日期
		adjustStatus	Integer	是		处理状态	0-待处理 1-处理成功 2-处理失败 3-审核拒绝
		adjustStatusDesc	String	是		处理状态描述	0-待处理 1-处理成功 2-处理失败 3-审核拒绝
		failDesc	String	否		失败原因
		adjustTime	String	是		充值时间	时间格式:yyyy-dd-MM HH:mm:ss
		requestor	String’	是		操作员(调账申请人)	接口调账为:接口导入
		auditor	String	是		调账审批人

 

请求示例

{"orderId":"20210914001","adjustType":"0","cardAdjustList":[{"cardNo":"202105120000001","value":"6"}]}

响应示例

{

"code": "0",

"data": "[{"couponName":"金额券0元0512001","adjustStatus":1,"auditor":"接口导入","adjustTime":"2021-09-14 10:02:14","cardNo":"202105120000001","validityEndDate":"2021-09-30 23:59:59","requestor":"接口导入","adjustType":0,"validityBeginDate":"2021-05-12 00:00:00","balance":6.00,"adjustStatusDesc":"处理成功","initAmount":0,"balanceChanged":6.0000}]",

"sign": "cS/NJZo1+eUyLdeFzeFj8ZpiZtYL6R+lbMuSqYGVPaAuikHIx71UGkq0KdOxKFYctBRTjFG9s85GGSf7oq1BjIsUYoVUC+9nNANfGgF1UpzRngkyD0PBboCiM0v0zvd4pP3ishKhprSXdupNfREUwYjWq5NLO9F9gWf7tXK/7sA="

}

3.2.24储值卡调账查询

支持现金卡和计次卡调账结果查询。

 

method: allinpay.shopoint.couponService.cardAdjustQuery

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
orderId	String	是	60	外部调账订单号

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	否		错误信息
data	records		List	是		调账明细列表
		adjustType	Integer	是		调账类型	0-现金卡 2-计次卡
		cardNo	String	是		实体卡卡号
		couponName	String	是		券名称
		balanceChanged	BigDecimal	是		调账数量(对应调账接口的value)	单位元-现金卡 单位次-计次卡
		initAmount	BigDecimal	是		初始面额	单位元-现金卡 单位次-计次卡
		balance	BigDecimal	是		调账后余额	单位元-现金卡 单位次-计次卡
		validityBeginDate	String	是		有效期起始日期
		validityEndDate	String	是		有效期截止日期
		adjustStatus	Integer	是		处理状态	0-现金卡 2-计次卡
		adjustStatusDesc	String	是		处理状态描述	0-待处理 1-处理成功 2-处理失败 3-审核拒绝
		failDesc	String	否		失败原因
		adjustTime	String	是		充值时间	时间格式:yyyy-dd-MM HH:mm:ss
		requestor	String’	是		操作员(调账申请人)	接口充值为:接口导入
		auditor	String	是		调账审批人

 

请求示例

{"orderId ":"122212132323231231"}

响应示例

{

"code": "0",

"data": "[{"couponName":"金额券0元0512001","adjustStatus":1,"auditor":"接口导入","adjustTime":"2021-09-14 10:02:14","cardNo":"202105120000001","validityEndDate":"2021-09-30 23:59:59","requestor":"接口导入","adjustType":0,"validityBeginDate":"2021-05-12 00:00:00","balance":6.00,"adjustStatusDesc":"处理成功","initAmount":0,"balanceChanged":6.0000}]",

"sign": "cS/NJZo1+eUyLdeFzeFj8ZpiZtYL6R+lbMuSqYGVPaAuikHIx71UGkq0KdOxKFYctBRTjFG9s85GGSf7oq1BjIsUYoVUC+9nNANfGgF1UpzRngkyD0PBboCiM0v0zvd4pP3ishKhprSXdupNfREUwYjWq5NLO9F9gWf7tXK/7sA="

}

 

3.2.25 卡/券交易流水分页查询

method: allinpay.shopoint.couponService.couponConsumePageQuery

version: 1.0

前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
token	String	是		调用3.1.6 统一登录（scope=4）后获得的token。
pageNo	Integer	否		页码	不填默认1, 最小为1
consumeStartTime	String	否		核销开始时间	格式：yyyy-MM-dd HH:mm:ss
consumeEndTime	String	否		核销结束时间	格式：yyyy-MM-dd HH:mm:ss 建议在同一条件分页查询时，始终指定一个结束时间，避免新增数据干扰查询结果
couponName	String	否		券名称
promotionId	Integer	否		活动Id
couponType	Integer	否		券类型	0，金额券 2，计次券 3，满减券
consumeType	Integer	否		交易方式	30，大众码牌订单核券 31，POS订单 32，商城订单 33，码牌订单 34，POS直接核券 35，导购直接核券 42，接口核券 311，订单取消 312，API接口撤销交易
customerName	String	否		会员姓名
customerMobile	String	否		会员手机号
operatorName	String	否		操作员
sendShopName	String	否		发券店铺名称
consumeShopName	String	否		消费门店名称
couponNo	String	否		券号
tranNo	String	否		流水号
orderCode	String	否		订单号
outOrderId	String	否		外部订单号
sendOrgId	Integer	否		发券机构Id	token身份为集团机构可用，且与consumeOrgId必传一个
consumeOrgId	Integer	否		核券机构Id	token身份为集团机构可用，且与consumeOrgId必传一个
dimension	Integer	否		查看维度	token身份为集团机构可用 1，按发券归属查看 2，按核券归属查看
remark	String	否		备注

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data	total		Integer	否		总数	只在第1页中返回交易流水总条数
	pageNo		Integer	是		分页页码
	pageSize		Integer	是		分页大小
	resultList		List	否		流水分页
		changeId	Integer	是		交易Id
		sendOrgId	Integer	是		发券机构Id
		sendOrgName	String	是		发券机构名称
		consumeOrgId	String	是		核券机构Id
		consumeOrgName	Integer	是		核券机构名称
		promotionId	Integer	是		券活动ID
		couponNo	Integer	是		券号
		orderCode	Integer	是		订单号
		outOrderId	Integer	是		外部订单号
		tranNo	String	是		流水号
		cardNo	String	否		实体卡号
		couponName	Integer	否		券名称
		couponType	String	否		券类型	0-金额券,2-计次券,3-满减券
		balanceChanged	BigDecimal	是		交易数量(元/张)
		newBalance	BigDecimal	是		余额(元/张)
		createSourceDesc	String			发券门店
		createTime	String			交易时间	yyyy-MM-dd HH:mm:ss
		orderRemark	String			交易备注
		createUserName	String			发卡备注
		changeSource	Integer			来源编号
		changeSourceDesc	String			来源描述
		name	String			会员姓名
		mobile	String			会员手机号
		nickName	String			会员昵称
		orgOpenId	String			openid
		shopId	Integer			消费门店编号
		shopName	String			消费门店名称
		shopCode	String			店铺号
		consumeUserName	String			操作员
		referee	String			推荐人(券来源)

请求示例

{

    "pageNo": "1",

    "pageSize": "10",

    "consumeTimeStart": "2022-08-26 14:00:00",

    "consumeTimeEnd": "2022-08-26 17:00:00"

}

响应示例

{

    "total": 2,

    "pageNo": 1,

    "pageSize": 10,

    "resultList": [

        {

            "changeSource": 311,

            "couponName": "lq121401",

            "createTime": "2022-08-26 14:41:02",

            "couponType": 0,

            "newBalance": 400,

            "couponNo": "83000100000000055331",

            "changeId": 272525,

            "shopId": 147,

            "templateId": 6244620,

            "balanceChanged": 400,

            "createUserLoginName": "hl导购"

        },

        {

            "changeSource": 31,

            "couponName": "lq121401",

            "createUserId": 358,

            "createTime": "2022-08-26 14:39:16",

            "couponType": 0,

            "newBalance": 0,

            "couponNo": "83000100000000055331",

            "changeId": 272522,

            "shopId": 147,

            "templateId": 6244620,

            "balanceChanged": -400,

            "createUserLoginName": "hl导购"

        }

    ]

}

 

3.2.26 作废卡/券发放

撤销3.2.7发的卡/券

method: allinpay.shopoint.couponService.couponSendListCancel

versionId: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
tranNo	String	是		发券凭证（流水号）
orderId	String	是	60	本次撤销的流水号
cancelLevel	Integer	否		作废级别,该凭证下的券必须全部符合该级别才能进行作废,默认为1	1-未领取的电子券 2-全部为未领取或未使用的券 3-有未使用的部分券

 

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是		错误信息
data	orderId		String	是		流水号	请求参数中的orderId
	cancelTime		String	是		作废时间
	list			是		交易券明细
		instruction	String	是		券使用须知
		couponName	String	是		券名称
		couponNo	String	否		券号	发券对象，或纸质券时有效

 

请求示例

{

    "orderId": "1236158361962",

    "tranNo": "165416131313",

    "cancelLevel": 1

}

 

响应示例

{

    "code": 0,

    "data": {

        "orderId": "1236158361962",

        "cancelTime": "2023-07-28 16:45:46",

        "list": [

            {

                "couponName": "测试ZHT",

                "instruction": "测试",

                "couponNo": "62163546544"

            }

        ]

    },

    "token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"

}

 

3.2.27卡/券核销

根据卡号或券号或动态码核销卡或者券。

method: allinpay.shopoint.couponService.couponConsumeV1

version: 1.0

 

业务请求参数

字段名		参数类型	必填	最大长度	说明	取值
shopId		String	否		店铺ID
shopCode		String	否		店铺号	与shopId功能相同，shopId和shopCode同时输入则只取shopId，shopId和shopCode必输一项
operUserId		String	是		收银员id	收银员登录名称
orderId		String	是		外部核券订单号
couponConsumeList			是		验卡/券列表
	couponNo	String	是		卡号或券号或券动态码
	consumeAmount	String	是		核销次数	计次卡（券）类单位为：次
	passwd	String	否		密码,核销卡时与cidao至少填一项	券动态码及没密码时可为”” 加密传输（详见2.3.4）
	cidao	String	否		磁道信息, 核销卡时与passwd至少填一项
	principalAmt	Decimal	否		本金	单位为元
	remark	String	否		备注
	stlmShopList	List	否		结算店铺信息
	stlmShopId	Integer	否		结算店铺id
	stlmShopCode	String	否		结算店铺号
	stlmAmount	Decimal	否		结算金额, 单位元

 

业务响应参数

字段名				参数类型	必填	最大长度	说明	取值
code				Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg				String	是		错误信息
data	orgName			String	是		机构/商户名称
	tranNo			String	是		交易流水号
	couponConsumeDetail			List	是		验券交易详情
		couponNo		String	是		券号
		financeList		List	是		财务科目列表
			accountNo	String	是		财务科目号
			accountTitle	String	是		财务科目名称
			accountPriority	Integer	是		财务科目优先级
			accountValue	BigDecimal	是		科目值	科目值根据算法自动算出金额

 

请求示例

{"shopId":"1","operUserId":"1","couponConsumeList":[{"couponNo":"10000000010000055943","consumeAmount":"1","remark":"哈哈"}]}

响应示例

{

    "code": 0,

    "data": true,

    "sign": "VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o="

}

3.2.33卡/券动账流水

接口方法：method: allinpay.shopoint.memberService.couponRechargePageQuery

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
token	String	是		调用3.1.6 统一登录（scope=4）后获得的token。
pageNo	Integer	否		页码	不填默认1, 最小为1
couponType	Integer	否		卡券类型	0-金额券, 2-计次券
consumeType	Integer	否		交易方式	24-后台卡券充值, 25-API卡券充值, 44后台卡券调账， 70-电子券作废, 73-接口卡券调账, 75-退卡, 80-存量储值卡导入, 81-存量电子券导入
rechargeRequestUserName	String	否		操作人
couponNo	String	否		券号
cardNo	String	否		实体卡号
beginTime	String	否		开始时间	时间格式:yyyy-dd-MM HH:mm:ss
endTime	String	否		结束时间	时间格式:yyyy-dd-MM HH:mm:ss
couponName	String	否		卡券名称

 

业务响应参数

字段名			参数类型	必填	最大长度	说明	取值
code			Integer	是	4	返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg			String	是	200	错误信息
data	total		Integer	否		总数	只在第1页中返回交易流水总条数
	current		Integer	是		分页页码
	size		Integer	是		分页大小
	records		List	否		流水分页
		couponNo	String	是		券号
		balance	String	是		变更数量	单位： 金额券：元 计次券：次
		cardNo	String	否		实体卡号
		couponTypeDesc	String	否		卡券类型	0-金额券, 2-计次券
		changeSourceDesc	String	是		变更类型
		createTime	String	否		变更时间	时间格式:yyyy-dd-MM HH:mm:ss
		couponName	String	是		卡券名称
		consumeUserName	String	否		操作人
		requestUserName	String	否		审批员

请求示例

{

    "pageNo":1,

    "couponName":"的风格",

    "couponType":0,

    "rechargeRequestUserName":"lq",

    "consumeType":24,

    "couponNo":"8600010060000264425",

    "beginTime":"2023-11-20T00:00:00",

    "endTime":"2023-11-21T23:59:59",

"cardNo":"8600010060000264425"

}

响应示例

{

  "records": [

    {

      "couponNo": "8600010060000264425",

      "cardNo": "8600010060000264425",

      "couponName": "的风格",

      "couponTypeDesc": "后台卡券充值",

      "balance": 50元,

      "createTime": "2023-11-20 17:03:48",

      "changeSourceDesc": "后台卡券充值",

      "consumeUserName": "lq,

      "requestUserName": "lq"

    }

  ],

  "total": 1,

  "size": 10,

  "current": 1,

  "pages": 1

}

3.2.35券号查询该顾客同券模板下的券号列表

依据券号或券动态码该顾客同券模板下的券号列表详细信息

 

method: allinpay.shopoint.couponService.query

version: 1.0

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
pageNo	Integer	否		页码	1-1000，默认1
pageSize	Integer	否		页大小	1-200，默认200
couponNo	String	是		券号或券动态码
queryMode	String	否		查询类型	single（默认）-查询输入的券号详细信息 template-券号查询该顾客同券模板下的券号列表

业务响应参数

字段名		参数类型	必填	最大长度	说明	取值
code		Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg		String	是		错误信息
data	templateId	Integer	是		模板ID
	couponNo	String	是		券号
	couponName	String	是		券名称
	couponType	Integer	是		券类型	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-已核销 4-已挂失 5-转赠中 6-失效 7-待兑换 8-已兑换 9-退款中
	unusableReason	String	否		不可使用的原因	Status不为0是有描述
	hasPassword	Boolean	是		是否有密码	True或false
	usableAmount	BigDecimal	否		每满多少金额可以使用1张	couponType=3满减券时有效
	usableMaxNum	Integer	否		每笔订单最多使用多少张	couponType=3满减券时有效
	instruction	String	否		券使用须知

请求示例

{

    "pageNo": "1",

    "pageSize": "10",

    "couponNo": "100152202011230002",

    "queryMode":"single"

}

响应示例

{

   "code":"0",

   "data":{

      "coupons":[

         {

            "couponName":"导购外部计次",

            "couponNo":"100152202011230002",

            "hasPassword":false,

            "templateId":1504,

            "validityEndDate":"2020-12-12 23:59:59",

            "unusableReason":"",

            "validityBeginDate":"2020-11-23 00:00:00",

            "unit":"次",

            "validityType":1,

            "balance":6.00,

            "couponType":2,

            "instruction":"不限制",

            "initAmount":6.00,

            "status":0

         }

      ],

      "pageNo":10,

      "pageSize":1

   }

}

3.2.36卡/券冻结

将有效状态的券改未冻结状态

method: allinpay.shopoint.couponService.couponFreeze

version: 1.0

 

业务请求参数

字段名	参数类型	必填	最大长度	说明	取值
activityCode	String	是	100	券码	加密传输（详见2.3.4）
shopId	Integer	是	10	操作店铺
guideSysno	Integer	是	10	操作人

 

业务响应参数

字段名	参数类型	必填	最大长度	说明	取值
code	Integer	是		返回码	0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码
msg	String	是		错误信息

 

请求示例

{

    "activityCode": "ASAJSKDAKSHSAHDKASHFKAFJD",

    "shopId": 1,

    "guideSysno": 1

}

响应示例

{

"code": 0,

"data":"{}"

}