Skip to main content

电子券核销查询接口

基本信息

接口名称:电子券核销查询接口状  态:已完成
接口路径:POST /paas/micro/ecoupon/query-verifyQuery更新时间:2022-08-20 00:36:27
Mock地址:https://apimock.e-buychina.com/mock/617/paas/micro/ecoupon/query-verifyQuery

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring是请求序列最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring是请求APPID最大长度:50
最小长度:1
Mock:@natural
actionstring是交易类型最大长度:50
最小长度:1
Mock:verifyQuery
timestampnumber是时间戳Mock:@timestamp
signTypestring是签名类型最大长度:20
最小长度:1
Mock:sha256
signstring是签名值最大长度:500
最小长度:1
Mock:@natural
langstring是语言Mock:zh_CN
contentobject是请求报文
  originalUuidstring是原始请求流水号最大长度:64
最小长度:10
Mock:@now('yyyyMMdd')-@string('lower',32)
  codesarray否查询code列表,为空查询原是核销的所有code

返回数据

参数名称类型必填默认值备注其他信息
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是返回产品明细标记
    fundsChannelobject否资金渠道
      totalAmountnumber是总金额
      userRealAmountnumber是用户实付金额
      merchantRealAmountnumber是用户实收金额
      discountAmountnumber是折抵金额
      channelBenefitnumber是渠道优惠
      merchantBenefitnumber是商户优惠
      benefitAmountnumber是总优惠金额
      merchantCustomRealAmountnumber是商户指定实付
      merchantCustomBenefitnumber是商户指定优惠
    fineGrainedLimitobject否最细粒度限量规则
      grainedKeystring否
      limitMaxValueinteger否
      currentinteger否
    userInfoobject否用户信息
      mobilestring是
      thirdPlatformTypestring是
      thirdUserIdstring是
    remarksstring否
    verifyStatusstring否
    errorMessagestring否

备注

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

变更历史

变更日期变更内容
2021-12-15
2021-12-02
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-18
api-id=34137