Skip to main content

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

基本信息

接口名称:同步卡包内电子券状态状  态:已完成
接口路径:POST /paas/micro/voucherwallet/updateVoucherStatus更新时间:2023-12-14 19:27:10
Mock地址:https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/updateVoucherStatus

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:updateVoucherStatus
timestampnumber返回时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject返回报文
  voucherQrcodestring卡券号最大长度:50
最小长度:1
Mock:@string
  memberIdstring租户会员ID(由插卡包接口提供)最大长度:50
最小长度:1
Mock:@string
  voucherStatusstring修改后的状态(00可使用,01已使用,02可使用(一码多次使用时,码还有可用次数),03未激活,04已冻结,05已作废,06已过期,07未生效,09码异常)最大长度:50
最小长度:1
Mock:@string
  remainTimesinteger剩余可用次数(券)Mock:@natural
  totalTimesinteger总可用次数(券)Mock:@natural
  validStartstring有效期开始时间(yyyyMMddHHmmss)最大长度:50
Mock:@string
  validEndstring有效期结束时间(yyyyMMddHHmmss)最大长度:50
Mock:@string

返回数据

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

备注

场景一:外部电子券券状态、剩余可用次数、有效期更新通知到卡包
场景二:MQ消费者触发此接口(生产者由paas-micro-whale和paas-micro-order商家券微服务及订单微服务提供)

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

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

将返回为:

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

变更历史

变更日期变更内容
2023-12-14
2023-12-14
2022-04-24
2022-02-09
2022-02-09
2022-02-09
2022-02-09
2022-02-09
2022-02-09
2021-05-28
2021-05-28
2021-05-28
api-id=29792