【聚合类】激活卡券并插卡包

基本信息

接口名称：	激活卡券并插卡包(标准分支特有功能)	状态：	已完成
接口路径：	POST /paas/micro/voucherwallet/activeVoucher	更新时间：	2024-08-26 23:42:19
Mock地址：	https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/activeVoucher

请求参数

Headers:

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

Body:

参数名称	类型	必填	默认值	备注	其他信息
uuid	string	是		uuid	最大长度：50 最小长度：1 Mock：@now('yyyyMMdd')-@string('lower',32)
appId	string	是		应用id	最大长度：50 最小长度：1 Mock：@string
action	string	是		交易名称	最大长度：50 最小长度：1 Mock：activeVoucher
timestamp	number	是		请求时间戳	Mock：@timestamp
signType	string	是		签名类型	最大长度：50 最小长度：1 Mock：sha_256
sign	string	是		签名值	最大长度：50 最小长度：1 Mock：@natural
content	object	是		请求体
voucherCode	string	是		券码	最大长度：50 最小长度：1
phoneNumber	string	是		手机号	最大长度：50 最小长度：1
shopNo	string	是		核销门店	最大长度：50 最小长度：1 Mock：99990
lang	string	否

返回数据

参数名称	类型	必填	默认值	备注	其他信息
uuid	string	是		uuid	最大长度：50 最小长度：1 Mock：@now('yyyyMMdd')-@string('lower',32)
action	string	是		交易名称	最大长度：50 最小长度：1 Mock：activeVoucher
content	object	是		响应报文
cardList	array	否		结构同voucherList
voucherList	array	否		用户券列表
remainTimes	number	是		剩余可用次数	Mock：@integer
voucherStatusDesc	string	是		卡券状态描述	最大长度：50 最小长度：1 Mock：@string
voucherName	string	是		券名称	最大长度：50 最小长度：1 Mock：@string
totalTimes	number	是		总次数	Mock：@integer
validEndTime	string	是		卡券有效期结束时间	最大长度：50 最小长度：1 Mock：@datetime
voucherCode	string	是		券码	最大长度：50 最小长度：1 Mock：@string
productType	string	是		产品类型	最大长度：50 最小长度：1 Mock：Voucher
createDate	number	是		创建时间	Mock：@datetime
validStartTime	string	是		卡券有效期开始时间	最大长度：50 最小长度：1 Mock：@datetime
createBy	string	是		创建人	最大长度：50 最小长度：1 Mock：@string
voucherStatus	string	是		卡券状态	最大长度：50 最小长度：1 Mock：@string
faceValue	number	是		面值
voucherExtend	string	是		卡券扩展字段	最大长度：50 最小长度：1
totalCount	number	是		总数	Mock：1
success	boolean	是		是否成功	Mock：@boolean
errorCode	string	是		错误码	最大长度：50 最小长度：1 Mock：@natural
errorMessage	string	是		错误信息	最大长度：50 最小长度：1
timestamp	number	是		响应时间戳	Mock：@timestamp
signType	string	否
sign	string	否

备注

请求示例：

{
  "content": {
    "phoneNumber": "176******",
    "voucherCode": "10032870698162*****"
  },
  "uuid": "20240731-jtgkrdtjeuwkzqbddesdjnxqjvebaysl",
  "appId": "ebuy0a0fd74341cc",
  "action": "activeVoucher",
  "timestamp": 1722413869,
  "signType": "sha_256",
  "sign": "4789268584454036",
  "lang": "est eiusmod"
}

响应示例：

{
  "uuid": "20240731-jtgkrdtjeuwkzqbddesdjnxqjvebaysl",
  "action": "activeVoucher",
  "content": {
    "cardList": [],
    "voucherList": [
      {
        "remainTimes": 1,
        "voucherStatusDesc": "可使用",
        "voucherName": "照烧鸡三明治三件套",
        "phoneNumber": "176*******",
        "totalTimes": 1,
        "validEndTime": "20241028235959",
        "voucherCode": "1003287069816******",
        "productType": "Voucher",
        "createDate": 1722418903000,
        "validStartTime": "20240731000000",
        "createBy": "system",
        "voucherStatus": "00",
        "faceValue": 36,
        "voucherExtend": "{\"ticketDetail\":{\"paymentParam\":{\"discountCode\":\"F069|2\",\"tenderCode\":\"P116|34\",\"goods\":[{\"quantity\":\"\",\"price\":\"\",\"goodsId\":\"5021006\",\"goodsName\":\"\"}]},\"supportNextDayCancel\":\"Y\",\"skuList\":[\"5031005\"],\"voucherType\":\"merchandiseCoupon\",\"netValue\":\"34.00\",\"voucherImage\":\"\",\"shopWhiteList\":[\"73011\",\"99990\"],\"faceValue\":\"36.00\",\"supportSameDayCancel\":\"Y\",\"useDesc\":\"\"}}"
      }
    ],
    "totalCount": 1
  },
  "success": true,
  "errorCode": "",
  "errorMessage": "",
  "timestamp": 1722500968954,
  "signType": "sha256",
  "sign": "486e1ef7c6c2c12aeef9e42c6c65fde90a269709b0063b71de64738863e473fc"
}

其中voucherExtend中ticketDetail字段相关含义如下：
supportVerify: true/false 门店是否可用
supportNextDayCancel：是否支持隔日退
supportSameDayCancel：是否支持当日退
faceValue：面值
netValue：净值
minLimit：门槛金额（有则返回）
discountAmount：折扣金额（有则返回）
weekTimes：可用时间段（JSONArray有则返回）
/*
* 可用时间段
* times: 000000235959(前六位是开始时间, 后6位是结束时间)
* weekDay: 0011000(周日周一周二周三周四周五周六，0:不可用, 1:可用)
*/
cityBlackList: 城市黑名单列表（有则返回）
cityWhiteList: 城市白名单列表（有则返回）
shopBlackList：门店黑名单列表（有则返回）
shopWhiteList：门店白名单列表（有则返回）
voucherType: 券类型（约定值，示例：product表示产品券）
skuList：可用商品列表
defaultGoodsId: 多组n选1套餐(示例:“defaultGoodsld":"110507,110508,11509|124138,123103,123204"表示A组商品:110507110508，110509二选1，B组商品:124138，123103，123204选1)

变更历史

变更日期	变更内容
2024-08-26	{"path":"\/activeVoucher","params":[]} {"path":"\/activeVoucher","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50},"shopNo":{"type":"string","description":"核销门店","minLength":1,"maxLength":50,"mock":{"mock":"99990"}}},"required":["phoneNumber","voucherCode","shopNo"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"uuid","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"activeVoucher"},"description":"交易名称","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"cardList":{"type":"array","items":{"type":"string"},"description":"结构同voucherList"},"voucherList":{"type":"array","items":{"type":"object","properties":{"remainTimes":{"type":"number","description":"剩余可用次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true,"mock":{"mock":"@integer"}},"voucherStatusDesc":{"type":"string","description":"卡券状态描述","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"voucherName":{"type":"string","description":"券名称","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"totalTimes":{"type":"number","description":"总次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true,"mock":{"mock":"@integer"}},"validEndTime":{"type":"string","description":"卡券有效期结束时间","minLength":1,"maxLength":50,"mock":{"mock":"@datetime"}},"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"productType":{"type":"string","description":"产品类型","minLength":1,"maxLength":50,"mock":{"mock":"Voucher"}},"createDate":{"type":"number","description":"创建时间","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@datetime"}},"validStartTime":{"type":"string","description":"卡券有效期开始时间","minLength":1,"maxLength":50,"mock":{"mock":"@datetime"}},"createBy":{"type":"string","description":"创建人","mock":{"mock":"@string"},"minLength":1,"maxLength":50},"voucherStatus":{"type":"string","description":"卡券状态","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"faceValue":{"type":"number","description":"面值","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"voucherExtend":{"type":"string","description":"卡券扩展字段","minLength":1,"maxLength":50}},"required":["validEndTime","voucherCode","productType","createDate","validStartTime","createBy","voucherStatus","voucherExtend","faceValue","totalTimes","voucherStatusDesc","remainTimes","voucherName"]},"description":"用户券列表"},"totalCount":{"type":"number","mock":{"mock":"1"},"description":"总数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true}},"description":"响应报文","required":["totalCount"]},"success":{"type":"boolean","description":"是否成功","mock":{"mock":"@boolean"}},"errorCode":{"type":"string","description":"错误码","mock":{"mock":"@natural"},"minLength":1,"maxLength":50},"errorMessage":{"type":"string","description":"错误信息","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"响应时间戳"},"signType":{"type":"string"},"sign":{"type":"string"}},"required":["content","uuid","action","success","errorCode","errorMessage","timestamp"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"uuid","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"activeVoucher"},"description":"交易名称","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"cardList":{"type":"array","items":{"type":"string"},"description":"结构同voucherList"},"voucherList":{"type":"array","items":{"type":"object","properties":{"remainTimes":{"type":"number","description":"剩余可用次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true,"mock":{"mock":"@integer"}},"voucherStatusDesc":{"type":"string","description":"卡券状态描述","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"voucherName":{"type":"string","description":"券名称","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"totalTimes":{"type":"number","description":"总次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true,"mock":{"mock":"@integer"}},"validEndTime":{"type":"string","description":"卡券有效期结束时间","minLength":1,"maxLength":50,"mock":{"mock":"@datetime"}},"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"productType":{"type":"string","description":"产品类型","minLength":1,"maxLength":50,"mock":{"mock":"Voucher"}},"createDate":{"type":"number","description":"创建时间","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@datetime"}},"validStartTime":{"type":"string","description":"卡券有效期开始时间","minLength":1,"maxLength":50,"mock":{"mock":"@datetime"}},"createBy":{"type":"string","description":"创建人","mock":{"mock":"@string"},"minLength":1,"maxLength":50},"voucherStatus":{"type":"string","description":"卡券状态","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"faceValue":{"type":"number","description":"面值","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"voucherExtend":{"type":"string","description":"卡券扩展字段","minLength":1,"maxLength":50}},"required":["validEndTime","voucherCode","productType","createDate","validStartTime","createBy","voucherStatus","voucherExtend","faceValue","totalTimes","voucherStatusDesc","remainTimes","voucherName"]},"description":"用户券列表"},"totalCount":{"type":"number","mock":{"mock":"1"},"description":"总数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true}},"description":"响应报文","required":["totalCount"]},"success":{"type":"boolean","description":"是否成功","mock":{"mock":"@boolean"}},"errorCode":{"type":"string","description":"错误码","mock":{"mock":"@natural"},"minLength":1,"maxLength":50},"errorMessage":{"type":"string","description":"错误信息","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"响应时间戳"},"signType":{"type":"string"},"sign":{"type":"string"}},"required":["content","uuid","action","success","errorCode","errorMessage","timestamp"]}
2024-08-01	{"path":"\/activeVoucher","params":[]} {"path":"\/activeVoucher","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"uuid","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"activeVoucher"},"description":"交易名称","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"cardList":{"type":"array","items":{"type":"string"},"description":"结构同voucherList"},"voucherList":{"type":"array","items":{"type":"object","properties":{"remainTimes":{"type":"number","description":"剩余可用次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"voucherStatusDesc":{"type":"string","description":"卡券状态描述","minLength":1,"maxLength":50},"voucherName":{"type":"string","description":"券名称","minLength":1,"maxLength":50},"totalTimes":{"type":"number","description":"总次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"validEndTime":{"type":"string","description":"卡券有效期结束时间","minLength":1,"maxLength":50},"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"productType":{"type":"string","description":"产品类型","minLength":1,"maxLength":50},"createDate":{"type":"number","description":"创建时间","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@time"}},"validStartTime":{"type":"string","description":"卡券有效期开始时间","minLength":1,"maxLength":50},"createBy":{"type":"string","description":"创建人","mock":{"mock":"@string"},"minLength":1,"maxLength":50},"voucherStatus":{"type":"string","description":"卡券状态","minLength":1,"maxLength":50},"faceValue":{"type":"number","description":"面值","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"voucherExtend":{"type":"string","description":"卡券扩展字段","minLength":1,"maxLength":50}},"required":["validEndTime","voucherCode","productType","createDate","validStartTime","createBy","voucherStatus","voucherExtend","faceValue","totalTimes","voucherStatusDesc","remainTimes","voucherName"]},"description":"用户券列表"},"totalCount":{"type":"number","mock":{"mock":"1"},"description":"总数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true}},"description":"响应报文","required":["totalCount"]},"success":{"type":"boolean","description":"是否成功","mock":{"mock":"@boolean"}},"errorCode":{"type":"string","description":"错误码","mock":{"mock":"@natural"},"minLength":1,"maxLength":50},"errorMessage":{"type":"string","description":"错误信息","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"响应时间戳"},"signType":{"type":"string"},"sign":{"type":"string"}},"required":["content","uuid","action","success","errorCode","errorMessage","timestamp"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"uuid","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"activeVoucher"},"description":"交易名称","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"cardList":{"type":"array","items":{"type":"string"},"description":"结构同voucherList"},"voucherList":{"type":"array","items":{"type":"object","properties":{"remainTimes":{"type":"number","description":"剩余可用次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true,"mock":{"mock":"@integer"}},"voucherStatusDesc":{"type":"string","description":"卡券状态描述","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"voucherName":{"type":"string","description":"券名称","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"totalTimes":{"type":"number","description":"总次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true,"mock":{"mock":"@integer"}},"validEndTime":{"type":"string","description":"卡券有效期结束时间","minLength":1,"maxLength":50,"mock":{"mock":"@datetime"}},"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"productType":{"type":"string","description":"产品类型","minLength":1,"maxLength":50,"mock":{"mock":"Voucher"}},"createDate":{"type":"number","description":"创建时间","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@datetime"}},"validStartTime":{"type":"string","description":"卡券有效期开始时间","minLength":1,"maxLength":50,"mock":{"mock":"@datetime"}},"createBy":{"type":"string","description":"创建人","mock":{"mock":"@string"},"minLength":1,"maxLength":50},"voucherStatus":{"type":"string","description":"卡券状态","minLength":1,"maxLength":50,"mock":{"mock":"@string"}},"faceValue":{"type":"number","description":"面值","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"voucherExtend":{"type":"string","description":"卡券扩展字段","minLength":1,"maxLength":50}},"required":["validEndTime","voucherCode","productType","createDate","validStartTime","createBy","voucherStatus","voucherExtend","faceValue","totalTimes","voucherStatusDesc","remainTimes","voucherName"]},"description":"用户券列表"},"totalCount":{"type":"number","mock":{"mock":"1"},"description":"总数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true}},"description":"响应报文","required":["totalCount"]},"success":{"type":"boolean","description":"是否成功","mock":{"mock":"@boolean"}},"errorCode":{"type":"string","description":"错误码","mock":{"mock":"@natural"},"minLength":1,"maxLength":50},"errorMessage":{"type":"string","description":"错误信息","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"响应时间戳"},"signType":{"type":"string"},"sign":{"type":"string"}},"required":["content","uuid","action","success","errorCode","errorMessage","timestamp"]}
2024-08-01	{"path":"\/activeVoucher","params":[]} {"path":"\/activeVoucher","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"uuid","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"activeVoucher"},"description":"交易名称","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"cardList":{"type":"array","items":{"type":"string"},"description":"结构同voucherList"},"voucherList":{"type":"array","items":{"type":"object","properties":{"remainTimes":{"type":"number","description":"剩余可用次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"voucherStatusDesc":{"type":"string","description":"卡券状态描述","minLength":1,"maxLength":50},"voucherName":{"type":"string","description":"券名称","minLength":1,"maxLength":50},"totalTimes":{"type":"number","description":"总次数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"validEndTime":{"type":"string","description":"卡券有效期结束时间","minLength":1,"maxLength":50},"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"productType":{"type":"string","description":"产品类型","minLength":1,"maxLength":50},"createDate":{"type":"number","description":"创建时间","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@time"}},"validStartTime":{"type":"string","description":"卡券有效期开始时间","minLength":1,"maxLength":50},"createBy":{"type":"string","description":"创建人","mock":{"mock":"@string"},"minLength":1,"maxLength":50},"voucherStatus":{"type":"string","description":"卡券状态","minLength":1,"maxLength":50},"faceValue":{"type":"number","description":"面值","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"voucherExtend":{"type":"string","description":"卡券扩展字段","minLength":1,"maxLength":50}},"required":["validEndTime","voucherCode","productType","createDate","validStartTime","createBy","voucherStatus","voucherExtend","faceValue","totalTimes","voucherStatusDesc","remainTimes","voucherName"]},"description":"用户券列表"},"totalCount":{"type":"number","mock":{"mock":"1"},"description":"总数","minimum":1,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true}},"description":"响应报文","required":["totalCount"]},"success":{"type":"boolean","description":"是否成功","mock":{"mock":"@boolean"}},"errorCode":{"type":"string","description":"错误码","mock":{"mock":"@natural"},"minLength":1,"maxLength":50},"errorMessage":{"type":"string","description":"错误信息","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"响应时间戳"},"signType":{"type":"string"},"sign":{"type":"string"}},"required":["content","uuid","action","success","errorCode","errorMessage","timestamp"]}
2024-07-31	{"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} {"path":"\/activeVoucher","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {} {}
2024-07-31	{"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} {"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"{{ @now(\'yyyyMMdd\')-@string(\'lower\',32) }}"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {} {}
2024-07-31	{"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} {"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"{{ @now(\'yyyyMMdd\')-@string(\'lower\',32) }}"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content"]} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"{{ @now(\'yyyyMMdd\')-@string(\'lower\',32) }}"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content","uuid","appId","action","timestamp","signType","sign"]} {} {}
2024-07-31	{"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} {"path":"\/paas\/micro\/voucherwallet\/activeVoucher","params":[]} [] [{"required":"1","name":"Content-Type","value":"application\/json"}] {}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","minLength":1,"maxLength":50,"description":"uuid","mock":{"mock":"{{ @now(\'yyyyMMdd\')-@string(\'lower\',32) }}"}},"appId":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"@string"},"description":"应用id"},"action":{"type":"string","minLength":1,"maxLength":50,"mock":{"mock":"activeVoucher"},"description":"交易名称"},"timestamp":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"mock":{"mock":"@timestamp"},"description":"请求时间戳"},"signType":{"type":"string","description":"签名类型","mock":{"mock":"sha_256"},"minLength":1,"maxLength":50},"sign":{"type":"string","description":"签名值","minLength":1,"maxLength":50,"mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"voucherCode":{"type":"string","description":"券码","minLength":1,"maxLength":50},"phoneNumber":{"type":"string","description":"手机号","minLength":1,"maxLength":50}},"required":["phoneNumber","voucherCode"],"description":"请求体"},"lang":{"type":"string"}},"required":["content"]} {} {}

api-id=37218

【主档类】创建租户用户

【主档类】创建租户会员

【主档类】获取用户详情

【主档类】获取会员详情

【资产类】获取会员资产

【资产类】获取会员卡信息

【聚合类】创建用户及会员

【资产类】查询卡券包列表

【资产类】查询单张卡券详情

【通知类】同步天正会员信息并合并资产

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

【聚合类】激活卡券并插卡包

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

【安全类】JWT颁发请求令牌

【资产类】卡券包资产整合

【资产类】卡包指定资产移除

【通知类】现金卡状态通知

【通知类】电子券状态通知

【资产类】卡包所有资产移除

【新券标志】查询新券数量

【新券标志】移除新券标志

【资产类】恢复删除的卡券

【通知类】同步卡券产品配置

【转赠】赠送

【转赠】领取

【转赠】撤销

【转赠】查询转赠详情

【转赠】查询卡券转赠记录

【交易类】单卡消费交易

【交易类】当日消费撤销

【交易类】隔日消费退款

查询卡余额

交易记录查询

扣款接口

退款

统一下单

支付结果查询

回调外部交易结果通知

预支付接口

支付结果查询-old

退款查询

统一下单

交易查询

申请退款

退款查询

回调外部交易结果通知

获取 TOKEN

拉起收银台插件

查询支付交易结果

交易退款

用户资产查询

获取支付渠道

收银中台常量

同步外部订单

物流同步接口

鉴权绑定直播账号

【聚合类】激活卡券并插卡包

基本信息

请求参数

Headers:

Body:

返回数据

备注

变更历史

No Comments