Skip to main content

电子券核销撤销接口

基本信息

接口名称:电子券核销撤销接口状  态:已完成
接口路径:POST /paas/micro/ecoupon/verify-verifyCancel更新时间:2025-03-21 22:46:55
Mock地址:https://apimock.e-buychina.com/mock/617/paas/micro/ecoupon/verify-verifyCancel

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型-verifyCancel最大长度:50
最小长度:1
Mock:verifyCancel
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject请求报文
  originalUuidstring原始请求流水号最大长度:64
最小长度:10
Mock:@now('yyyyMMdd')-@string('lower',32)
  originalVerifyDatestring原始核销日期最大长度:100
最小长度:1
Mock:@now('yyyyMMdd')
  codesarray撤销code列表,为空将撤销原是核销的所有code
  isAtomicitystring多张券撤销是否需要全部成功才返回,否则全部失败 Y 是,N否,不传默认N最大长度:1
最小长度:1
Mock:@string
  supportSaleRealTimeVerifystring是否支持销售渠道实时核销Y是(默认为空 是),N否

返回数据

参数名称类型必填默认值备注其他信息
outerOrderIdstring制码订单号原样下发最大长度:64
最小长度:1
Mock:@string
createTimenumber交易成功与否Mock:@now('yyyyMMddHHmmss')-@string('lower',32)
actionstring交易类型最大长度:50
最小长度:1
Mock:makeEcoupon
timestampnumber返回时间戳Mock:@timestamp
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
signTypestring签名类型最大长度:20
Mock:sha256
signstring签名值最大长度:500
Mock:@natural
contentobject返回报文
  verifyCancelResultListarray核销撤销结果列表
    codestring券码code最大长度:50
最小长度:1
Mock:@string
    ticketIdnumber券批次idMock:@integer(1,1000)
    ticketNamestring券批次名称最大长度:200
最小长度:1
Mock:@string
    orderRemarksstring制码订单备注最大长度:200
最小长度:1
Mock:@string
    amountnumber核销撤销金额Mock:@float(10,2)
    statusstring核销撤销状态Mock:@string
    statusDescstring核销撤销状态描述Mock:@string

备注

  1. ticketId为券批次号,由券系统提供给销售渠道。销售渠道再根据其顾客选购商品上传正确的批次号。
  2. commissionDate = -1时,所制串码的状态为“03:未激活”。销售渠道拿到该串码后,择机调用激活接口将串码状态变更为“00:初始状态”。
  3. 相对有效期和绝对有效期,只可择其一上送,若二者均上送,以绝对有效期优先。
  4. 选择上传相对有效期时,可以选择上送commissionDate,若未上送则commissionDate字段系统默认为0。commissionDate = 0表示当日生效,commissionDate = 1表示次日生效,以此类推。
  5. 商户授权时,若未填写销售价,则制码时资金渠道必填。并且在核销串码时,将制码资金渠道中商户实收金额作为净值下发给收银机。

变更历史

变更日期变更内容
2025-03-21
2024-01-24
2022-01-16
2021-11-17
2021-11-17
2021-11-16
2021-11-16
2021-11-16
2021-10-22
2021-07-30
2021-07-28
2021-07-28
api-id=32177