e-Buy 电子券4.0

JSON Key为fundsChannel，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 totalAmount Number 否 订单总金额 单位：分。t...

JSON Key为remainFundsChannel，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 remainTotalAmount Number 否 剩...

JSON Key为verifyFundsChannel，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 totalAmount Number 否 订单总金额 ...

JSON Key为makeFundsChannel，非必填 字段 类型 是否必填 字段意义 备注 totalAmount Number 是 总金额(A+B) 单位：分 ch...

JSON Key为goodsDetail，必填 字段 类型 是否必填 字段意义 备注 sku String 是 商品SKU   qty Integer 是 数量  ...

码明细 JSON Key为memberDetail，必填 字段 类型 是否必填 字段意义 备注 memberId String 否 会员ID   memberName ...

JSON Key为redeemCodeDetail，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 realCode String 是 兑换码兑换后的真实串码号...

制码通知类型 制码时，当需要易百通知到用户，可由取码方指定通知渠道及渠道用户信息 字段 类型 是否必填 字段意义 备注 mobilePhone String 否 短信通知手机...

当取码方需要易百协助调用制码方完成微信卡包通知时，制码时上传该字段 字段 类型 是否必填 字段意义 备注 userUnionId String 否 微信用户唯一识别号   ...

JSON Key为updateOpts，必填 字段 类型 是否必填 字段意义 备注 updatePurchaseTime String 否 修改实际购买时间 yyyyMMdd...

JSON Key为codeQueryResponseData，必填 字段 类型 是否必填 字段意义 备注 codeDetail List<codeQueryCodeDetail> ...

JSON Key为codeQueryCodeDetail，必填 字段 类型 是否必填 字段意义 备注 code String 是 码号   saleChannelOrder...

JSON Key为Items，必填 字段 类型 是否必填 字段意义 备注 saleChannelItemId String 是 取码方子订单号 小于32个字符 ticket...

JSON Key为codeArr，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 code String 否 券码 seq Number 否 阶梯序...

JSON Key为batchMakeCodeResponseData，必填 字段 类型 是否必填 字段意义 备注 returnCode String 是 请求返回码   r...

JSON Key为makeQueryResponseData，必填 字段 类型 是否必填 字段意义 备注 saleChannelOrderId String 是 取码方订单号 ...

制码订单查询明细返回 JSON Key为makeQueryResponseItem，必填 字段 类型 是否必填 字段意义 备注 saleChannelItemId String ...

订单券码明细返回 JSON Key为makeOrderResponseCodeDetail，必填 字段 类型 是否必填 字段意义 备注 codeURL String(100) ...

制码订单返回码数据 JSON Key为makeVoidResponseData，必填 字段 类型 是否必填 字段意义 备注 originalChannelOrderId Stri...

制码订单返回码 JSON Key为makeVoidResponseVoidDetail，必填 字段 类型 是否必填 字段意义 备注 ticketId String 是 券id...

JSON Key为statusUpdateData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百交易号   requestId St...

JSON Key为batchCodeActivateResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 系统内部编号   ...

JSON Key为storeInfo此信息为线下门店核销时上送 字段 类型 是否必填 字段意义 备注 swift String 否 pos流水号   tid String...

JSON Key为storeInfo此信息为线下门店核销时上送 字段 类型 是否必填 字段意义 备注 swift String 否 pos流水号   tid Stri...

JSON Key为singleMakeOrderResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百订单号   re...

JSON Key为codeVerifyResponseData，必填 字段 类型 是否必填 字段意义 备注 cashTotalAmount Number 否 原样返回 c...

JSON Key为codeVerifyQueryResponseData，必填 字段 类型 是否必填 字段意义 备注 returnCode String 是 单个串码核销查询结...

预核销明细 JSON Key为codeCheckResponseData，必填 字段 类型 是否必填 字段意义 备注 code String 是 劵码   codeVal...

JSON Key为batchCodeVerifyResponseData，必填 字段 类型 是否必填 字段意义 备注 code String 是 原样返回   saleCh...

券码批量核销撤销明细 JSON Key为batchCodeVerifyVoidResponseData，必填 字段 类型 是否必填 字段意义 备注 code String 是 ...

JSON Key为channelTicketQueryData，必填 字段 类型 是否必填 字段意义 备注 ticketId String 否 券id 组合券活动时，此处非必...

JSON Key为Items，必填 字段 类型 是否必填 字段意义 备注 saleChannelItemId String 是 取码方子订单号 小于32个字符 tradeI...

JSON Key为esbMakeOrderResponseData，必填 字段 类型 是否必填 字段意义 备注 saleChannelId String 是 取码方id 需原...

JSON Key为esbMakeCodeResponseItem，必填 字段 类型 是否必填 字段意义 备注 saleChannelItemId String 是 取码方子订单...

JSON Key为activityUseDescription，必填 字段 类型 是否必填 字段意义 备注 useDescription String 否 使用说明

JSON Key为ticketUseDescription，必填 字段 类型 是否必填 字段意义 备注 ticketPicture String 否 券图片   useTh...

JSON Key为fineGrainedRuleLimit，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 grainedKey String 是 粒度key ...

JSON Key为getMobileBySearchCodeResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百交易编号...

JSON Key为sendVerificationCodeResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百交易编号

JSON Key为checkVerificationCodeResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百交易编号...

JSON Key为getDynamicResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百交易编号   reques...

券码批量更新回调返回明细 JSON Key为codeUpdateCallbackData，必填 字段 类型 是否必填 字段意义 备注 searchCode String 是 ...

券码批量更新返回明细 JSON Key为batchCodeUpdateResponseData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 ...

券码批量更新回调返回明细 JSON Key为batchCodeVoidCallbackData，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 ...

JSON Key为notifyCodeToCardPackageResponse，必填 字段 类型 是否必填 字段意义 备注 tradeNo String 是 易百交易编号 ...

JSON Key为codeFamilyInfoList，必填 字段 类型 是否必填 字段意义 备注 code String 是 券码   codeMask String ...

券模板配置 字段 类型 是否必填 字段意义 备注 makeNotifyConf String 是 制码通知配置 00：不通知，01：通知用户 verifyNotifyCon...

字段 类型 是否必填 字段意义 备注 batchMakeNotifyConf String 是 批量制码接口通知配置 00：不通知，01：通知用户 makeNotifyCon...

制码渠道配置 字段 类型 是否必填 字段意义 备注 makeCodeUrl String 否 第三方制码URL   needRealTimeVerify String ...

销售渠道配置 字段 类型 是否必填 字段意义 备注 messageFormat String 否 与取码方对接时报文格式 ebuy：易百标准格式，third：取码方报文格式 ...

接口用途 支持请码方一次单品请求调用,单品发码数量上限100 接口说明 每次调用时必须有明确的渠道订单编号。 commissionDate = -1时，所制码不具有支付功能（即码没有激活...

接口用途 当需要查询发码订单结果时，取码方调用此接口 当调用同步单条发码超时或未知状态，取码方调用此接口确认交易结果 此接口不支持异步批量发码的订单查询 接口说明 每一次销售渠道对接w...

接口用途 电子凭证取码方需要批量(一次请求取码数超过1条)制码时，调用此接口 接口说明 每一次取码方对接whale进行制码，生成一个制码订单。 制码订单以渠道方订单编号为分表位，每次调用...

接口用途 异步批量下单接口所要求的码全部成功生成后，通过此接口将码信息回调到取码方 接口说明 接口与“异步批量发码”是一组接口来完成业务 此接口以http post请求方式回调取码方ca...

接口用途 当需要撤销某笔制码订单时，取码方调用此接口 接口说明 当对原制码订单进行撤销时，生成一个撤销订单。 对原订单进行撤销时，整单所制码都将被撤销。如需对单码撤销，调用电子凭证码状态...

接口用途 当需要查询对某笔订单的撤销结果时，取码方调用此接口 接口说明 当制码撤销结果未返回或因为超时等原因未能及时收到返回结果,可进行制码撤销查询 action MakeVoidQu...

接口用途 当需要作废码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 ...

接口用途 当需要冻结码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 ...

接口用途 当需要解冻码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 ...

接口用途 当需要激活码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 action CodeSt...

接口用途 多码批量激活时，调用此接口 接口说明 一次可以多码激活,一次最多20个码。 action BatchCodeActivate 请求参数，CHANNEL===>WHALE ...

接口用途 多码批量延期时，调用此接口 批量延期有两种方式：1.所有的码同一个有效期；2.每个码单独对应一个有效期。 接口说明 一次可以多码延期,一次最多1000个码。 action ...

接口用途 多码批量作废时，调用此接口 接口说明 一次可以多码作废,一次最多20个码。 action BatchCodeUpdate 请求参数，CHANNEL===>WHALE 字段...

接口用途 当需要对指定码的部分信息进行更新时，调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeDetailUpdate 请求参数，...

接口用途 当需要查询某个指定码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeQuery 请求参数，CHANNEL===...

接口用途 券码进行核销时，调用此接口 接口说明 一次只能对一个码进行核销。 action CodeVerify 请求参数，CHANNEL===>WHALE 字段 类型 是否必填...

接口用途 当需要将本次核销交易撤销时调用 接口说明 此接口支持撤销指定日期的核销交易 action CodeVerifyVoid 请求参数，CHANNEL===>WHALE 字段 ...

接口用途 核销接口调用超时对核销结果未知道，可以调用此接口来查询核销结果 接口说明 此接口默认支持查询当日内核销交易 也可传参originalDate查询指定日核销交易 action ...

接口用途 用于实现易百券核销成功后将核销状态通知到第三方系统 接口说明 接口异步通知第三方 请求参数，WHALE===>CHANNEL 字段 类型 是否必填 字段意义 备注 ...

接口用途 用于实现易百券核销撤销成功后将通知到第三方系统 接口说明 接口异步通知第三方 请求参数，WHALE<===>CHANNEL 字段 类型 是否必填 字段意义 备注 r...

接口用途 当需要确认码是否可用在当前场景时，调用此接口， 接口说明 建议单码场景使用。多码需确认是否满足需求。 action CodeCheck 请求参数，CHANNEL===>WH...

接口用途 多码批量核销时，调用此接口 接口说明 一次可以多码核销,一次最多10个码。 action BatchCodesVerify 请求参数，CHANNEL===>WHALE 字...

接口用途 批量核销接口调用超时对核销结果未知道，可以调用此接口来查询核销结果 接口说明 此接口默认支持查询当日内核销交易 也可传参originalDate查询指定日核销交易 actio...

接口用途 多码批量核销订单撤销时或订单中部分码撤销，调用此接口。 接口说明 撤销批量核销订单，调用前请确认订单是否符合撤销条件。 action BatchCodeVerifyVoid ...

接口用途 当取码方需要知道自己可用的券时，可调用此接口 action ChannelTicketQuery 请求参数，CHANNEL===>WHALE 字段 类型 是否必填 字段...

接口用途 用于实现外部系统劵成功后通知到易百 接口说明 第三方通知EBUY action CodeVerifyNotify 请求参数，CHANNEL===>WHALE 字段 类型...

接口用途 用于实现第三方核销撤销EBUY的劵成功后通知WHALE 接口说明 第三方核销撤销成功后通知EBUY action CodeVerifyVoidNotify 请求参数，CHA...

接口用途 当需要将已制出的串码通知到用户微信卡包时，调用此接口 接口说明 易百不提供插入微信卡包功能，插入卡包的服务商为该码的制码方。 此接口为异步执行，同步返回成功表明任务提交成功，实...

接口用途 当需查询箱包本码集合 接口说明 传入箱、本、码编号，分别获得对应的码列表   请求参数 字段 类型 是否必填 字段意义 备注 queryType String ...

接口用途 用于异步第三方制码的请求参数，发送到whale-gateway数据格式 接口说明 这里规定了标准的请求报文格式，发送到whale-gateway模块，然后具体对于不同码商的报文格...

接口用途 第三方券码异步处理完成后的通知接口 接口说明 接收统一的报文格式 action AsynThirdCodeCallback 请求参数，CHANNEL===>WHALE 字...

接口用途 多码批量作废时，调用此接口 接口说明 一次可以多码作废,一次最多20个码。 action SyncBatchCodeUpdate 请求参数，CHANNEL===>WHALE...

接口用途 用于异步第三方制码的请求参数，发送到whale-gateway数据格式 接口说明 这里规定了标准的请求报文格式，接收ebuyweb-gateway请求 action sync...

[yapi_interface]617[/yapi_interface]

接口用途 当需要查询某个指定码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeQueryBySearchCode 请求参数，CHAN...

[yapi_interface]14869[/yapi_interface]

接口用途 当有新的电子凭证活动时，ERP调用此接口 接口说明 PM做电子凭证立项后，3.0系统的活动Id绑定到电子凭证活动中，做一一对应关系 action activityInsert...

接口用途 当需要页面中展示制码通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要whale进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必...

接口用途 当需要对制码重新通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要whale进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必须有...

接口用途 当有新的销售渠道对接时，ERP调用此接口 接口说明 每个第三取码方均为一个销售渠道，ERP调用此接口后能新增一个销售渠道供日后取码使用 action saleChanneIn...

接口用途 当有新的制码渠道对接时，ERP调用此接口 接口说明 每个第三制码方均为一个制码渠道，ERP调用此接口后能新增一个制码渠道供日后制码使用 action sendChanneIn...

接口用途 当需要创建新的券模板时，ERP调用此接口 接口说明 每个易百productId对应一个券模板，一个券模板可供多个活动使用 action templateInsert 请求参...

接口用途 当需要页面中展示核销通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要whale进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必...

接口用途 当需要页面中展示核销通知时，ERP调用此接口 接口说明 如果销售渠道此次制码需要whale进行短信通知，则生成一条制码通知数据。 制码通知以渠道方订单编号为分表位，每次调用时必...

接口用途 创建规则 接口说明 本接口用来后台管平台创建规则 action createRule 请求参数，ERP===>WHALE 字段 类型 是否必填 字段意义 备注 ...

Whale同步调用ESB制码接口 接口用途 当Whale需要进行第三方制码时，Whale将请求报文发送给ESB，ESB再统一对不同制码方通信。 接口说明 单产品制码时，为同步制码，需实时...

第三方码实时作废请求报文 JSON Key为thirdCodeVoidRequest，必填 字段 类型 是否必填 字段意义 备注 code String 是 串码号   ...

接口用途 当电子凭证平台需要调用外部制码方激活接口对某些码进行激活时，调用该接口。 接口说明 该接口为电子凭证平台调用ESB做激活操作，ESB再根据不同制码方拼装报文并实时请求。 url...

接口用途 当电子凭证平台需要调用外部制码方码作废接口对某些码进行作废时，调用该接口。 接口说明 该接口为电子凭证平台调用ESB做激活操作，ESB再根据不同制码方拼装报文并实时请求。 请求...

接口用途 当电子凭证平台需要调用外部制码方进行核销时，调用该接口。 接口说明 该接口为电子凭证平台调用ESB做核销操作，ESB再根据不同制码方拼装报文并实时请求。 请求参数，WHALE=...

接口用途 当电子凭证平台需要调用外部制码方进行查询时，调用该接口。 接口说明 该接口为电子凭证平台调用ESB做查询操作，ESB再根据不同制码方拼装报文并实时请求。 请求参数，WHALE=...

接口用途 当电子凭证平台需要调用外部取码方进行查询时，调用该接口。 接口说明 该接口为电子凭证平台调用ESB做查询操作，ESB再根据不同制码方拼装报文并实时请求。 请求参数，WHALE=...

电子凭证系统通知到品牌渠道 接口用途 当电子凭证发生变更操作需要通知到品牌渠道时，调用该接口。 接口说明 该接口为异步通知接口，电子凭证系统无需返回值，由ESB负责与外部系统交互。 m...

电子凭证系统通知到取码方 接口用途 当电子凭证发生变更操作需要通知到取码方时，调用该接口。 接口说明 该接口为异步通知接口，电子凭证系统无需返回值，由ESB负责与外部系统交互。 mes...

电子凭证系统通知到制码方 接口用途 当电子凭证发生变更操作需要通知到制码方时，调用该接口。 接口说明 该接口为异步通知接口，电子凭证系统无需返回值，由ESB负责与外部系统交互。 mes...

电子凭证系统通知到代理商 接口用途 当电子凭证发生变更操作需要通知到代理商时，调用该接口。 接口说明 代理商：介于取码方与易百电子凭证系统之间，帮助取码方进行取码等操作，比如微信商家券系...

调用第三方插入微信卡包接口 接口用途 当取码方需要易百协助调用制码方完成微信卡包通知时，电子凭证平台请求ESB调用此接口。 制码方需提供给易百相应URL。 接口说明 该接口为电子凭证平...

接口用途 每间隔一段时间后，页面自动获取动态码时调用此接口。 接口说明 本接口调用需上传jwt。jwt来源于验证码校验接口下发。 action GenerateDynamicCode ...

制码通知数据 JSON Key为makeCodeNotify，必填 字段 类型 是否必填 字段意义 备注 notifyRequestId String(50) 是 本次通知流...

接口用途 易百制码成功后，通知到外部。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post调用。 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验...

接口用途 易百制码订单作废成功后，通知到外部。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post调用。 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公...

接口用途 取码方对码状态进行更新成功后，通知到外部。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post调用。 签名：该报文中签名是易百私钥签名，对接方需使用易百提...

接口用途 取码方对码进行延期成功后，通知到外部。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post调用。 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的...

接口用途 当易百自制码过期后，通知到外部。 每天凌晨将前一天过期的码执行通知。 单次通知最大支持100个串码。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post...

接口用途 串码核销成功后，通知到外部。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post调用。 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验...

接口用途 串码核销撤销成功后，通知到外部。 接口说明 该接口为异步通知接口，对接方需要提供http接口供易百post调用。 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进...

接口用途 激活前查询是否可以激活 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activePreQuery ...

接口用途 激活 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeVoucher action a...

接口用途 激活结果查询 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeResultQuery a...

接口用途 作废，作废后的券不可激活 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/delVoucher ac...

接口用途 核销信息以及城市范围查询 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/queryVerifyInf...

接口用途 激活 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/reelActiveVoucher actio...

接口用途 作废，作废后的券不可激活 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/reelDelVoucher...

接口用途 支付宝支付 微信被扫支付 银行二维码支付(工行、中行、中信、浦发等) 银行二维码积分兑换(工行、中行、中信、浦发等) 银联立码付 百度支付 翼支付 其他二维码支付 电...

接口用途 需要对原交易整体撤销时，可以在原交易的同一天调用此接口。 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/ap...

接口用途 在中间件未收到后台返回时，可以调用此接口查询原交易的状态。 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/a...