Skip to main content

电子券核销接口

基本信息

接口名称:电子券核销接口状  态:已完成
接口路径:POST /paas/micro/ecoupon/verify-verifyCode更新时间:2024-06-21 19:24:09
Mock地址:https://apimock.e-buychina.com/mock/617/paas/micro/ecoupon/verify-verifyCode

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring是请求序列最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring是请求APPID最大长度:50
最小长度:1
Mock:@natural
actionstring是交易类型,固定值verifyCode最大长度:50
最小长度:1
Mock:verifyCode
timestampnumber是时间戳Mock:@timestamp
signTypestring是签名类型最大长度:20
最小长度:1
Mock:sha256
signstring是签名值最大长度:500
最小长度:1
Mock:@natural
langstring是语言Mock:zh_CN
contentobject是请求报文
  verifyScenestring是核销场景Mock:SG001
  brandIdinteger是品牌编号Mock:1458
  cashTotalAmountnumber是上送金额Mock:30
  cashierTransNostring是收银机流水号Mock:uugyigxyijzirrjycvqg
  isPreVerifystring否是否为预核销,是Y,否N,不传默认为N最大长度:1
最小长度:1
Mock:@string
  isPartialSucstring否是否允许部分成功,是Y,否N,不传默认为NMock:@string
  redeemTicketIdstring否指定兑换产品批次idMock:@string
  redeemCountnumber否1指定兑换产品数量
  storeInfoobject是门店信息
    shopNostring是门店号Mock:SN001
    shopNamestring是门店名称Mock:SN001
    terminalIdstring否终端号
    merchantIdstring否商户号
    cityIdstring否城市Id
    cityNamestring否城市名称
    companyIdstring否管理公司Id
    companyNamestring否管理公司名称
  goodsListarray否商品明细列表
    skustring是skuMock:@natural
    qtyinteger是qtyMock:@integer(1,10)
    pricenumber是price单位元Mock:@integer(1,100)
    typestring否品类
    specstring否规格
    rebateCodestring否折扣
    reduceAmountnumber否折扣金额
    goodsTagstring否返回产品明细标记
  isProductCheckstring否是否产品规则校验
  extensionstring否扩展字段,品牌特殊业务通过此字段传值
  codeListarray是
  supportSaleRealTimeVerifystring否是否支持销售渠道实时核销Y是(默认为空 是),N否

返回数据

参数名称类型必填默认值备注其他信息
uuidstring是uuid最大长度:50
最小长度:1
Mock:makeEcoupon
appIdnumber是请求APPIDMock:@timestamp
successstring是交易是否成功最大长度:50
Mock:@word
actionstring是交易类型最大长度:50
Mock:@csentence
timestampnumber否返回时间戳
errorCodestring否错误码最大长度:500
Mock:@natural
errorMessagestring是错误信息
signTypestring是签名类型
signstring是签名值
contentobject是返回报文
  verifyCodeResultListarray是
    makeOrderIdstring否订单号
    faceValuenumber否面值
    codestring是码号
    ticketIdinteger否批次号
    ticketNamestring否批次名称
    ticketTypestring否批次类型
    ticketRemarksstring否批次备注
    ticketProductIdinteger否产品号
    thirdSendTicketIdstring否制码批次Id
    returnCashParamstring否拓展字段
    thirdActivityIdstring否第三方活动Id
    totalUseTimesinteger否总共可使用次数
    remainUseTimesstring否剩余可使用次数
    printDatastring否此值仅在易百POS上核销时需要用到
    goodsListarray否折抵商品列表(响应匹配有效的产品)
      skustring是sku
      qtystring是qty
      pricestring是价格单位分
      typestring是品类
      specstring是规格
      rebateCodestring否折扣
      reduceAmountstring否折抵金额
      goodsTagstring否返回产品明细标记
      extstring否扩展参数,收银对接时存放收银对接编号
      tagstring否有效产品打标记
    requestGoodsListarray否响应原始请求的产品
      skustring是sku
      qtystring是qty
      pricestring是价格单位分
      typestring是品类
      specstring是规格
      rebateCodestring否折扣
      reduceAmountstring否折抵金额
      goodsTagstring否返回产品明细标记
      extstring否扩展参数,收银对接时存放收银对接编号
      tagstring否有效产品打标记
    fundsChannelobject否资金渠道
      totalAmountnumber是总金额
      userRealAmountnumber是用户实付金额
      merchantRealAmountnumber是用户实收金额
      discountAmountnumber是折抵金额,券系统实际的优惠金额,收银机优惠多少只认这个金额font>
      channelBenefitnumber是渠道优惠
      merchantBenefitnumber是商户优惠
      benefitAmountnumber是总优惠金额
      merchantCustomRealAmountnumber是商户指定实付
      merchantCustomBenefitnumber是商户指定优惠
      channelCustomBenefitnumber是平台指定优惠
    fineGrainedLimitobject否最细粒度限量规则
      grainedKeystring否
      limitMaxValueinteger否
      currentinteger否
    userInfoobject否用户信息
      mobilestring是
      thirdPlatformTypestring是
      thirdUserIdstring是
    remarksstring否
    verifyStatusstring是
    verifyStatusDescstring否核销状态描述
    errorMessagestring是
    activityNostring否活动编号
    activityNamestring否活动名称
    cashTotalAmountnumber否透传返回主机上送金额
    redeemCodeDetailobject否
      realCodestring是兑换真实券码
      realTicketIdstring是兑换批次id
      realTicketNamestring是兑换批次名称
    redeemCodeDetailsarray否多次兑换券码结果
      codestring是兑换真实券码
      searchCodestring否兑换查询码
      codeURLstring否兑换短链
      useTimesnumber是可用次数
      statusstring是券码状态
      validStartstring是券码启用时间
      validEndstring是券码结束时间

备注

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

变更历史

变更日期变更内容
2024-06-21
2023-08-22
2023-05-08
2023-05-08
2023-05-08
2023-03-22
2023-02-02
2023-02-02
2023-02-02
2022-09-27
2022-09-27
2022-09-16
2022-07-28
2022-01-16
2022-01-07
2022-01-07
2021-12-30
2021-12-15
2021-12-12
2021-12-07
2021-12-07
2021-12-02
2021-11-30
2021-11-30
2021-11-30
2021-11-30
2021-11-30
2021-11-30
2021-11-30
2021-11-19
2021-11-19
2021-11-19
2021-11-19
2021-11-19
2021-11-18
2021-11-17
2021-11-16
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-10
2021-11-10
2021-10-20
2021-10-20
2021-10-19
2021-10-19
2021-10-19
2021-10-19
2021-10-19
2021-10-19
2021-10-19
2021-10-09
2021-10-09
2021-10-09
2021-10-09
2021-10-09
2021-10-09
2021-09-23
2021-09-23
2021-09-17
2021-09-17
2021-09-17
2021-09-17
2021-09-06
2021-08-23
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-08-13
2021-07-21
api-id=32027