ESB转发类接口--http转发请求接口

http转发请求数据

第三方码实时作废请求报文

字段 类型 是否必填 字段意义 备注
code String 是 串码号  
thirdCodeId String 否 制码时返回的第三方码id  
sendChannelOrderId String 否 制码时制码订单号  
whaleTicketId String 是 易百券id  
channelTicketId String 否 制码方分配的产品id  
codeRemark String 否 码备注信息

第三方码核销转发请求报文

字段 类型 是否必填 字段意义 备注
code String 是 串码号  
verifyScene String 是 核销场景 online：线上，offline：线下
tid String 否 易百终端id 线下核销场景存在机具信息时必填
shopNo String 否 易百门店编号 线下核销场景存在机具信息时必填
shopName String 否 易百门店名称 线下核销场景存在机具信息时必填
goodsDetail List<goodsDetail> 否 (只有在收银POS上发起交易时才上送)

第三方码核销转发返回报文

字段 类型 是否必填 字段意义 备注
thirdTicketId String 是 串码号  
thirdTicketName String 是 核销场景 online：线上，offline：线下
thirdActivityId String 否 易百终端id 线下核销场景存在机具信息时必填
thirdActivityName String 否 易百门店编号 线下核销场景存在机具信息时必填
verifyTime String 否 易百门店名称 线下核销场景存在机具信息时必填
verifyFundsChannel Object<verifyFundsChannel> 否 第三方码核销转发资金渠道  
returnCode String(2) 是 第三方核销结果码 00：成功，其他均为失败
returnMsg String 是 第三方核销结果

第三方码核销转发资金渠道

字段 类型 是否必填 字段意义 备注
faceValue Number 否 面值，券面金额  
settlementAmount Number 否 结算金额  
discountAmount Number 否 折抵金额  
channelDiscountAmount Number 否 渠道折抵金额  
merchantDiscountAmount Number 否 商户折抵金额  
totalAmount Number 否 购买时订单总金额  
userRealAmount Number 否 购买时用户实付  
merchantRealAmount Number 否 商户实收金额  
benefitAmount Number 否 购买时总优惠金额  
channelBenefit Number 否 购买时渠道优惠  
merchantBenefit Number 否 购买时商户优惠

 

第三方码查询转发请求报文

字段 类型 是否必填 字段意义 备注
code String 是 串码号  
requestId String 是 流水号  
brandId String 否 易百终端id

第三方码查询转发返回报文

字段 类型 是否必填 字段意义 备注
code String 是 串码号  
codeStatus String 是 码状态 见下文
codeStatusDesc String 是 码状态描述  
codeValidStart String 是 码有效期开始时间 yyyyMMddHHmmss
codeValidEnd String 是 码有效期结束时间 yyyyMMddHHmmss
purchaseTime String 是 电子凭证购买时间 yyyyMMddHHmmss
verifyDate String 否 核销日期 yyyyMMdd
verifyTime String 是 核销时间 yyyyMMddHHmmss
ebuyTicketId String 否 易百产品id 当第三方返回报文里有易百产品信息则必填
ebuyTicketName String 否 易百产品名称 当第三方返回报文里有易百产品信息则必填
thirdTicketId String 是 第三方产品id  
thirdTicketName String 是 第三方产品名称  
ebuyActivityId String 否 易百活动id  
ebuyActivityName String 否 易百活动名称  
thirdActivityId String 否 第三方活动id  
thirdActivityName String 否 第三方活动名称  
returnCode String(2) 是 第三方查询结果码 00：成功，其他均为失败
returnMsg String 是 第三方查询呢结果

券状态枚举

字段 字段意义 备注
00 可使用
01 已使用
02 可使用(一码多次使用时，码还有可用次数)
03 未激活 未激活的码需调用激活接口才能
04 已冻结
05 已作废
06 已过期  
07 未生效 当制码时选择次日生效，核销时会返回该状态
09 码异常，不能用

第三方码激活

接口用途

接口说明

url

请求参数，WHALE===>ESB

字段 类型 是否必填 字段意义 备注
channelId String 是 外部制码方id  
requestId String(32) 是 请求流水号  
codeArray List 是 待激活码  
validStart String 是 码有效开始时间  
validEnd String 是 码有效结束时间

请求报文举例

{
    "channelId":"10002401",
    "requestId": "20180905112600001",
    "codeArray": ["100809051126021", "100809051126022"],
    "validStart": "20180905112600",
    "validEnd": "20181005112600"
}

返回参数，ESB===>WHALE

字段 类型 是否必填 字段意义 备注
returnCode String 是 返回码  
returnMsg String 是 返回信息

返回报文举例

{
    "returnCode": "00",
    "returnMsg": "SUCCESS"
}

第三方码作废

接口用途

接口说明

请求参数，WHALE===>ESB

字段 类型 是否必填 字段意义 备注
channelId String 是 制码方id  
optTag String 是 操作类型 ThirdCodeVoid
transferUrl String 是 通知地址  
messageType String 是 报文类型 Ebuy:易百标准报文格式，Third:第三方自定义格式
whaleMessage String 是 易百标准报文 内容如下文

易百标准报文：第三方码实时作废

字段 类型 是否必填 字段意义 备注
appId String(10) 是 电子凭证系统对接方id  
action String(20) 是 业务标识 ThirdCodeVoid
bizContent String<thirdCodeVoidData> 是 第三方码实时作废数据 需要base64解码
version String(10) 是 版本号
timestamp String 是 时间戳  
sign String 是 签名

返回参数，ESB===>WHALE

字段 类型 是否必填 字段意义 备注
channelId String 是 渠道id。原样返回  
requestId String 是 请求流水号。原样返回  
returnCode String 是 返回码  
returnMsg String 是 返回信息

第三方码核销转发

接口用途

接口说明

请求参数，WHALE===>ESB

字段 类型 是否必填 字段意义 备注
channelId String 是 制码方id  
transferAction String 是 操作类型 ThirdCodeVerify
transferUrl String 是 通知地址  
messageType String 是 报文类型 Ebuy:易百标准报文格式，Third:第三方自定义格式
whaleMessage String 是 易百标准报文 内容如下文

易百标准报文：第三方码实时核销请求报文

字段 类型 是否必填 字段意义 备注
appId String(10) 是 电子凭证系统对接方id  
action String(20) 是 业务标识 ThirdCodeVerify
bizContent String<thirdVerifyTransferRequest> 是 第三方码实时作废数据 需要base64解码
version String(10) 是 版本号
timestamp String 是 时间戳  
sign String 是 签名

返回参数，ESB===>WHALE

字段 类型 是否必填 字段意义 备注
channelId String 是 渠道id。原样返回  
requestId String 是 请求流水号。原样返回  
returnCode String 是 返回码  
returnMsg String 是 返回信息  
whaleMessage String 是 易百标准报文 内容如下文

易百标准报文：第三方码实时核销返回报文

字段 类型 是否必填 字段意义 备注
appId String(10) 是 电子凭证系统对接方id  
action String(20) 是 业务标识 ThirdCodeVerify
bizContent String<thirdVerifyTransferResponse> 是 第三方码实时作废数据 需要base64解码
version String(10) 是 版本号
timestamp String 是 时间戳  
sign String 是 签名

第三方码查询转发

接口用途

接口说明

请求参数，WHALE===>ESB

字段 类型 是否必填 字段意义 备注
channelId String 是 制码方id  
transferAction String 是 操作类型 ThirdCodeQuery
transferUrl String 是 通知地址  
messageType String 是 报文类型 Ebuy:易百标准报文格式，Third:第三方自定义格式
whaleMessage String 是 易百标准报文 内容如下文

易百标准报文：第三方码实时查询请求报文

字段 类型 是否必填 字段意义 备注
appId String(10) 是 电子凭证系统对接方id  
action String(20) 是 业务标识 ThirdCodeQuery
bizContent String<thirdQueryTransferRequest> 是 第三方码实时查询数据 需要base64解码
version String(10) 是 版本号
timestamp String 是 时间戳  
sign String 是 签名

返回参数，ESB===>WHALE

字段 类型 是否必填 字段意义 备注
channelId String 是 渠道id。原样返回  
requestId String 是 请求流水号。原样返回  
returnCode String 是 返回码  
returnMsg String 是 返回信息  
whaleMessage String 是 易百标准报文 内容如下文

易百标准报文：第三方码实时查询返回报文

字段 类型 是否必填 字段意义 备注
appId String(10) 是 电子凭证系统对接方id  
action String(20) 是 业务标识 ThirdCodeQuery
bizContent String<thirdQueryTransferResponse> 是 第三方码实时查询数据 需要base64解码
version String(10) 是 版本号
timestamp String 是 时间戳  
sign String 是 签名

易百码核销转发

接口用途

接口说明

请求参数，WHALE===>ESB

字段 类型 是否必填 字段意义 备注
verifyUrl String 是 取码方核销地址  
saleChannelId String 是 取码方渠道id  
code String 是 串码号  
saleChannelOrderId String 是 取码方制码订单号  
verifyScene String 是 核销场景 online：线上，offline：线下
brandId String 否 品牌id
tid String 否 易百终端id 线下核销场景存在机具信息时必填
shopNo String 否 易百门店编号 线下核销场景存在机具信息时必填
shopName String 否 易百门店名称 线下核销场景存在机具信息时必填
goodsDetail List<goodsDetail> 否 (只有在收银POS上发起交易时才上送)  
messageFormat String 是 核销转发报文格式 ebuy：易百标准报文，third：第三方自定义报文

返回参数：易百码核销转发报文

字段 类型 是否必填 字段意义 备注
channelId String 是 电子凭证系统对接方id 对应请求报文中saleChannelOrderId字段
returnCode String 是 返回码 00：成功，其他均为失败。两位数字和字母组合
returnMsg String 是 返回信息