Skip to main content

【聚合类】领取卡券到卡包

基本信息

接口名称:聚合插入卡券包(自动创建用户会员)状  态:已完成
接口路径:POST /paas/micro/voucherwallet/apiAggregateInsertWallet更新时间:2025-04-14 21:54:40
Mock地址:https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/apiAggregateInsertWallet

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:apiAggregateInsertWallet
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度: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
  brandNamestring品牌名称最大长度:100
Mock:@string
  cardVoucherListarray
    productTypestring卡券的产品类型(Voucher 电子券,Cashcard 现金卡)最大长度:16
最小长度:1
Mock:@string
    productCodestring卡券的产品编号最大长度:32
最小长度:1
Mock:@string
    productSkustring产品券对应的产品SKU(支持英文逗号分隔多个)最大长度:255
Mock:@string
    voucherTypestring卡券类型:券类型(全场代金券orderVoucher,全场满减券orderReduceCoupon,全场折扣券orderDiscountCoupon,单品代金券productVoucher,单品满减券productReduceCoupon,单品折扣券productDiscountCoupon,换购券exchangeCoupon,买赠券BuyGiveCoupon,第M件折减券anyoneDiscountCoupon,搭配套餐券setMenuCoupon),现金卡类型(0不记名,1记名)最大长度:16
最小长度:1
Mock:@string
    voucherCodestring卡券码最大长度:32
最小长度:1
Mock:@string
    voucherNamestring卡券名称最大长度:64
最小长度:1
Mock:@string
    voucherCodeUrlstring卡券链接最大长度:255
Mock:@string
    voucherStatusstring卡券状态:券状态(00可使用,01已使用,02可使用(一码多次使用时,码还有可用次数),03未激活,04已冻结,05已作废,06已过期,07未生效,09码异常),现金卡状态(0未激活,1可用,2冻结,3已过期,4已退卡,5已销卡)最大长度:16
最小长度:1
Mock:@string
    faceValuenumber面值(单位:元)Mock:@float
    remainTimesinteger剩余可用次数(券)Mock:@integer
    totalTimesnumber总可用次数(券)Mock:@integer
    voucherAmountnumber可用金额(单位:元)Mock:@float
    merchantRealAmountnumber商户实收金额(单位:元)Mock:@float
    discountAmountnumber折扣金额(单位:元)Mock:@float
    templateUrlstring卡券模板链接最大长度:255
Mock:@string
    validStartTimestring有效期开始时间yyyyMMddHHmmss最大长度:20
最小长度:14
Mock:@string
    validEndTimestring有效期结束时间yyyyMMddHHmmss最大长度:20
最小长度:14
Mock:@string
    bindingTimestring发卡
券时间yyyyMMddHHmmss
最大长度:20
最小长度:14
Mock:@string
    voucherSourcestring卡券来源(无对应需求可以不上送)最大长度:32
最小长度:1
Mock:@string
    issuingChannelstring发放渠道(无对应需求可以不上送)最大长度:32
最小长度:1
Mock:@string
    depositChannelstring入账渠道(无对应需求可以不上送)最大长度:32
最小长度:1
Mock:@string
    voucherScopestring使用场景(无对应需求可以不上送)最大长度:256
最小长度:1
Mock:@string
    voucherDescstring卡券描述最大长度:2000
最小长度:1
Mock:@string
    voucherDescUrlstring卡券描述url(阿里云OSS全路径,json格式,包含使用说明、图片等)最大长度:500
最小长度:1
Mock:@string
    voucherExtendstring扩展信息(以json格式上传必要的拓展信息)最大长度:20
Mock:@string
    transferTimesLimitinteger0转赠次数限制

返回数据

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
actionstring交易类型最大长度:50
最小长度:1
Mock:apiAggregateInsertWallet
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返回报文
  guestIdstringPAAS用户ID最大长度:32
最小长度:1
Mock:@string
  memberIdstringPAAS租户会员ID,有手机号字段时返回最大长度:32
最小长度:1
Mock:@string
  platformIdstring平台ID最大长度:32
最小长度:1
Mock:@string
  ebuyMemberIdstring易百会员ID最大长度:32
最小长度:1
Mock:@string
  recordInfoarray参照cardVoucherList返回
    memberIdstring会员ID最大长度:1
最小长度:1
Mock:@word
    phoneNumberstring手机号最大长度:32
最小长度:1
Mock:@string
    tenancyIdnumber租户IDMock:@natural
    brandNamestring品牌名称最大长度:100
最小长度:1
Mock:@string
    ebuyMemberIdstring易百会员IDMock:@string
    thirdOpenIdstring第三方用户标识Mock:@string
    productTypestring卡券的产品类型(Voucher 电子券,Cashcard 现金卡)最大长度:16
最小长度:1
Mock:@string
    productCodestring卡券的产品编码最大长度:32
最小长度:1
Mock:@string
    productSkustring产品券对应的产品SKU(支持英文逗号分隔多个)最大长度:255
Mock:@string
    voucherTypestring卡券类型:券类型(全场代金券orderVoucher,全场满减券orderReduceCoupon,全场折扣券orderDiscountCoupon,单品代金券productVoucher,单品满减券productReduceCoupon,单品折扣券productDiscountCoupon,换购券exchangeCoupon,买赠券BuyGiveCoupon,第M件折减券anyoneDiscountCoupon,搭配套餐券setMenuCoupon),现金卡类型(0不记名,1记名)最大长度:16
最小长度:1
Mock:@string
    voucherNamestring卡券名称最大长度:32
最小长度:1
    voucherCodestring卡券码最大长度:32
最小长度:1
Mock:@string
    voucherStatusstring卡券状态:券状态(00可使用,01已使用,02可使用(一码多次使用时,码还有可用次数),03未激活,04已冻结,05已作废,06已过期,07未生效,09码异常),现金卡状态(0未激活,1可用,2冻结,3已过期,4已退卡,5已销卡)最大长度:16
最小长度:1
Mock:@string
    voucherStatusDescstring卡券状态描述最大长度:32
Mock:@string
    faceValuenumber面值(单位:元)Mock:@float
    remainTimesinteger剩余可用次数(券)Mock:@integer
    totalTimesinteger总可用次数(券)Mock:@integer
    voucherAmountnumber可用金额(单位:元)Mock:@float
    merchantRealAmountnumber商户实收金额(单位:元)Mock:@float
    discountAmountnumber折扣金额(单位:元)Mock:@float
    surfaceUrlstring卡面URL最大长度:256
最小长度:1
Mock:@string
    templateUrlstring卡券模板链接最大长度:50
最小长度:1
Mock:@string
    validStartTimestring有效期开始时间yyyyMMddHHmmss最大长度:20
最小长度:14
Mock:@string
    validEndTimestring有效期结束时间yyyyMMddHHmmss最大长度:20
最小长度:14
Mock:@string
    bindingTimestring发卡
券时间yyyyMMddHHmmss
最大长度:20
最小长度:14
Mock:@string
    voucherSourcestring卡券来源(无对应需求可以不上送)最大长度:32
最小长度:1
Mock:@string
    issuingChannelstring发放渠道(无对应需求可以不上送)最大长度:32
最小长度:1
Mock:@string
    depositChannelstring入账渠道(无对应需求可以不上送)最大长度:32
最小长度:1
Mock:@string
    voucherScopestring使用场景(无对应需求可以不上送)最大长度:256
最小长度:1
Mock:@string
    voucherDescstring卡券描述最大长度:2000
最小长度:1
Mock:@string
    voucherDescUrlstring卡券描述url(阿里云OSS全路径,json格式,包含使用说明、图片等)最大长度:500
最小长度:1
Mock:@string
    voucherExtendstring扩展信息最大长度:20
Mock:@string

备注

该接口可根据上送的openId,clientType,thirdAppId完成用户的创建,同时将卡券信息关联到该用户
上送phoneNumber时自动创建易百租户会员(不会重复创建,若上送的memberId已存在则插入到上送的memberId中)
此接口遵循插查一致原则(如上送thirdOpenId,可将本次上传的卡券信息关联到thirdOpenId,查询接口可支持根据上送的thirdOpenId进行查询)



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

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

将返回为:

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




变更历史

变更日期变更内容
2025-04-14
2025-03-26
2025-03-26
2025-03-26
2025-03-26
2023-12-14
2023-12-06
2022-02-24
2021-08-27
2021-08-27
2021-08-27
2021-08-27
2021-08-27
2021-06-17
2021-06-09
2021-06-02
2021-06-01
2021-05-31
2021-05-31
2021-05-30
2021-05-30
2021-05-29
2021-05-29
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2019-09-12
2019-09-12
2019-09-12
2019-09-12
2019-08-07
2019-08-06
2019-08-06
2019-08-01
2019-08-01
2019-08-01
2019-08-01
2019-08-01
2019-08-01
2019-08-01
2019-07-25
2019-07-25
2019-07-17
2019-07-17
2019-07-17
2019-07-17
2019-07-16
2019-07-16
2019-07-16
2019-07-16
2019-07-16
api-id=43