Search Results

制码渠道配置 字段 类型 是否必填 字段意义 备注 makeCodeUrl String 否 第三方制码URL   needRealTimeVerify String 否 是否需要第三方接口实时核销 0：是，1：否 forwardLink String 否 券使用跳转链接

销售渠道配置 字段 类型 是否必填 字段意义 备注 messageFormat String 否 与取码方对接时报文格式 ebuy：易百标准格式，third：取码方报文格式 needRealTimeVerify String 否 是否需要实时调用核销接口 Y：是，N：否 verifyUrl String 否 实时调用核销接口URL   needRealTimeVerifyVoid String 否 是否需要实时调用核销撤销接口 Y：是，N：否 verifyVoid...

接口用途 支持请码方一次单品请求调用,单品发码数量上限100 接口说明 每次调用时必须有明确的渠道订单编号。 commissionDate = -1时，所制码不具有支付功能（即码没有激活），如果需要激活该码的支付功能需要再次调用"码激活"接口。 同步单条发码时，saleChannelOrderId和saleChannelItemId可用同一值。 returnCode = "00"时，说明订单进入制码流程。itemResultCode = "00"时，说明订单制码成。 notifyType为券码发送到用...

接口用途 当需要查询发码订单结果时，取码方调用此接口 当调用同步单条发码超时或未知状态，取码方调用此接口确认交易结果 此接口不支持异步批量发码的订单查询 接口说明 每一次销售渠道对接whale进行制码，生成一个制码订单。 制码订单以渠道方订单编号为分表位，每次调用时必须有明确的订单编号 action MakeQuery 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 originalChannelOrderId String 是 原取码方制码订单...

接口用途 电子凭证取码方需要批量(一次请求取码数超过1条)制码时，调用此接口 接口说明 每一次取码方对接whale进行制码，生成一个制码订单。 制码订单以渠道方订单编号为分表位，每次调用时必须有明确的订单编号。 制码请求接收后，会同步返回制码前校验结果，后端成功生成码后，异步通知到callBackUrl指定的回调接口。 action MakeBatchCode 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 saleChannelOrderId Str...

接口用途 异步批量下单接口所要求的码全部成功生成后，通过此接口将码信息回调到取码方 接口说明 接口与“异步批量发码”是一组接口来完成业务 此接口以http post请求方式回调取码方callBackUrl地址 returnCode = "00"时，说明订单进入制码流程。resultCode = "00"时，说明子订单制码成。 如果未收到易百的回调请求，取码方可以传原订单号再次调用异步批量发码 返回参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 returnCo...

接口用途 当需要撤销某笔制码订单时，取码方调用此接口 接口说明 当对原制码订单进行撤销时，生成一个撤销订单。 对原订单进行撤销时，整单所制码都将被撤销。如需对单码撤销，调用电子凭证码状态更新接口。 此接口可对同步单条发码、异步批量发码下单接口订单进行撤销操作 对已撤销成功订单不能再次撤销 如果订单撤销部分成功时返回"tradeStatus"="P" 对订单中部分券码撤销成功时，可以按原制码订单号再次调用撤销接口，如还是部分撤销成功请联系易百技术方協助解决 action MakeVoid 请求参...

接口用途 当需要查询对某笔订单的撤销结果时，取码方调用此接口 接口说明 当制码撤销结果未返回或因为超时等原因未能及时收到返回结果,可进行制码撤销查询 action MakeVoidQuery 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 originalChannelOrderId String 是 取码方制码订单id 小于64个字符 orderDate String 是 原下单日期 yyyyMMdd requestId String...

接口用途 当需要作废码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 action CodeStatusUpdate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 code String 是 码号 小于22个字符 optTag Strin...

接口用途 当需要冻结码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 action CodeStatusUpdate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 channelOrderId String 是 销售渠道制码订单id 小于64个字符 requestId String 是 请求流水号 32个字符，用于标识唯一一...

接口用途 当需要解冻码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 action CodeStatusUpdate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 channelOrderId String 是 销售渠道制码订单id 小于64个字符 requestId String 是 请求流水号 32个字符，用于标识唯一一...

接口用途 当需要激活码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 action CodeStatusUpdate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 code String 是 码号 小于22个字符 codeValidDays Number 否 相...

接口用途 多码批量激活时，调用此接口 接口说明 一次可以多码激活,一次最多20个码。 action BatchCodeActivate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 codeArray List 是 码号数组   callBackUrl String 是 激活成功后的回调地址   activateShopNo String(1...

接口用途 多码批量延期时，调用此接口 批量延期有两种方式：1.所有的码同一个有效期；2.每个码单独对应一个有效期。 接口说明 一次可以多码延期,一次最多1000个码。 action BatchCodeUpdate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 codeArray List 否 码号数组 所有的码同一个有效期，与codeObjArray选择...

接口用途 多码批量作废时，调用此接口 接口说明 一次可以多码作废,一次最多20个码。 action BatchCodeUpdate 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 codeArray List 是 码号数组   saleChannelId Long 否 取码方id   saleChannelOrderId String 否 ...

接口用途 当需要对指定码的部分信息进行更新时，调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeDetailUpdate 请求参数，CHANNEL===>WHALE 字段 类型 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 code String 是 码号   updateOpts <updateOpt> 是 码明细更新操作 请求报文举例 { "req...

接口用途 当需要查询某个指定码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeQuery 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 codes List 是 验码集合 最大不超过20 brandId String 否 核销门店所属品牌 组合劵必须上送，易百提供 cityId S...

接口用途 券码进行核销时，调用此接口 接口说明 一次只能对一个码进行核销。 action CodeVerify 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 verifyScene String 是 交易场景.offline线下,online线上   code String 是 码号   isProductCheck String 是 是否校验订单产品规则 是Y，否N requestId String 是 请求流水号确保...

接口用途 当需要将本次核销交易撤销时调用 接口说明 此接口支持撤销指定日期的核销交易 action CodeVerifyVoid 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 小于32个字符 originalRequestId String 是 原核销请求流水号 32个字符，用于标识唯一一笔交易 请求报文举例 { "requestId": "10000000000000000...

接口用途 核销接口调用超时对核销结果未知道，可以调用此接口来查询核销结果 接口说明 此接口默认支持查询当日内核销交易 也可传参originalDate查询指定日核销交易 action CodeVerifyQuery 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段意义 备注 requestId String 是 请求流水号 32个字符，用于标识唯一一笔交易 originalRequestId String 是 原核销请求流水号 32个字符 orig...