Skip to main content

【聚合类】绑定单卡券到卡包

基本信息

接口名称:聚合单卡券验证及绑定(含外部卡券)状  态:已完成
接口路径:POST /paas/micro/voucherwallet/apiBindValidCheck更新时间:2023-05-30 21:32:56
Mock地址:https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/apiBindValidCheck

请求参数

Headers:

参数名称参数值是否必填
Content-Typeapplication/json

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:apiBindValidCheck
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:32
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject返回报文
  openIdstring微信、银联openId、支付宝userId、H5手机号最大长度:32
最小长度:1
Mock:@string
  clientTypestring 客户端类型:(WechatH5:微信H5, WechatMiniProgram:微信小程序, WechatMediaPlatform:微信公众号, AlipayMobileApp:支付宝移动应用, AlipayWebApp:支付宝网页应用, AlipayPublicApp:支付宝生活号, AlipayTinyApp:支付宝小程序, AlipayArApp:支付宝AR应用, UnionPayH5:银联H5, UnionPayMiniProgram:银联小程序, Facebook:脸书, H5:H5页面 )最大长度:32
最小长度:1
Mock:@string
  thirdAppIdstring第三方小程序ID
公众号ID(例如微信、支付宝、银联等,线下场景可上送"")
最大长度:32
最小长度:1
Mock:@string
  memberIdstring易百租户会员ID最大长度:32
Mock:@string
  thirdOpenIdstring第三方用户标识(可以是品牌其他供应商会员系统的thirdMemberId,亦可以是渠道用户唯一标识,例如微信unionId,支付宝userId)最大长度:64
Mock:@string
  phoneNumberstring手机号最大长度:11
Mock:@string
  productTypestring卡券的产品类型(Voucher 电子券,Cashcard 现金卡)最大长度:16
最小长度:1
Mock:@string
  voucherCodestring卡券码最大长度:32
最小长度:1
Mock:@string
  searchCodestring卡券查询码(卡面卡号,券序列号等,与voucherCode必须选其一上送,英文逗号拼接卡密后BASE64上送)最大长度:32
最小长度:1
Mock:@string
  extensionsstring绑卡业务拓展字段(可透传业务属性)最大长度:256
Mock:@string

返回数据

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
actionstring交易类型最大长度:50
最小长度:1
Mock:apiBindValidCheck
timestampnumber返回时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
successboolean交易成功与否Mock:@boolean
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
contentobject
  isValidboolean1是否绑定成功Mock:@boolean
  returnMessagestring绑定失败错误信息最大长度:20
Mock:@string

备注

* 1)本接口适用外部线下实体卡券以及线上外部卡券绑定到PAAS租户卡包场景
* 2)返回数据中的卡券对应产品信息需由对接方后端接口整合后返回(例如,验证完调用卡券产品查询接口,响应内容合并返回)
* 3)本接口请求报文严格参照聚合插卡包业务请求报文
* 4)本接口仅实现非资源化的请求报文校验与丢MQ消息队列业务逻辑

PAAS内部服务建议调用此接口前使用工具类WalletValidationUtil进行校验(需引入paas-micro-voucherwallet-shared依赖)

可参照聚合插卡包接口参照:https://apimock.e-buychina.com/project/77/interface/api/43

注意:为保证签名的一致性,返回报文中的content字段将以string形式的进行返回,例如:

{
	"content": {
		"userId": 1,
		"userName": "Trump"
	}
}

将返回为:

{
	"content": "{\"userId\":1,\"userName\":\"Trump\"}"
}




变更历史

变更日期变更内容
2023-05-30
2023-03-30
2022-02-24
2022-01-26
2021-10-19
2021-10-08
2021-10-08
2021-09-28
2021-09-28
2021-09-28
2021-09-28
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
2021-09-27
api-id=33227