星巴克预付费券系统
文档介绍
文档目的 此为取码方与易百电子凭证对接的报文协议 为实现取码方对接易百制码，制码查询，制码撤销，码信息查询，码状态修改，码信息修改等制码功能 开发测环境 线上接口路径 https://dev-s...
名词解释
HTTP 基于HTTP协议的通讯方式 JSON 网络通信时的一种数据交互格式 WHALE 易百电子凭证4.0系统的别称 JWT JWT是JSON Web Token的简写，它定义了...
业务参数对象
资金渠道
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为codeArr，出现在返回报文中，非必填 字段 类型 是否必填 字段意义 备注 code String 否 券码 seq Number 否 阶梯序...
制码请求子订单明细
JSON Key为Items，必填 字段 类型 是否必填 字段意义 备注 saleChannelItemId String 是 取码方子订单号 小于32个字符 ticket...
批量制码订单明细返回数据
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 组合券活动时，此处非必...
ESB制码订单明细
JSON Key为Items，必填 字段 类型 是否必填 字段意义 备注 saleChannelItemId String 是 取码方子订单号 小于32个字符 tradeI...
ESB制码订单返回码数据
JSON Key为esbMakeOrderResponseData，必填 字段 类型 是否必填 字段意义 备注 saleChannelId String 是 取码方id 需原...
ESB制码返回明细
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 ...
激活信息
JSON Key为extendData，必填 字段 类型 是否必填 字段意义 备注 purchaseOrderId String 否 用户购买订单号
接入说明
本文档展示了如何通过http请求，完成于易百电子凭证系统完成对接。 本文档主要面向的读者为各有需求接入电子凭证的，有一定开发能力的技术人员。 本文档中必填字段仅限于易百自制码，第三方制码可能存...
配置参数对象
券模板配置项
券模板配置 字段 类型 是否必填 字段意义 备注 makeNotifyConf String 是 制码通知配置 00：不通知，01：通知用户 verifyNotifyCon...
券配置项
字段 类型 是否必填 字段意义 备注 batchMakeNotifyConf String 是 批量制码接口通知配置 00：不通知，01：通知用户 makeNotifyCon...
发码方配置项
制码渠道配置 字段 类型 是否必填 字段意义 备注 makeCodeUrl String 否 第三方制码URL needRealTimeVerify String ...
取码方配置项
销售渠道配置 字段 类型 是否必填 字段意义 备注 messageFormat String 否 与取码方对接时报文格式 ebuy：易百标准格式，third：取码方报文格式 ...
线上交易类接口
同步单品发码（单个&批量发码与激活）
接口用途 支持请码方一次单品请求调用,单品发码数量上限100 接口说明 每次调用时必须有明确的渠道订单编号。 commissionDate = -1时，所制码不具有支付功能（即码没有激活...
发码订单查询
接口用途 当需要查询发码订单结果时，取码方调用此接口 当调用同步单条发码超时或未知状态，取码方调用此接口确认交易结果 此接口不支持异步批量发码的订单查询 接口说明 每一次销售渠道对接w...
码作废（退款）接口
接口用途 当需要作废码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 ...
码冻结接口
接口用途 当需要冻结码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 ...
码解冻接口
接口用途 当需要解冻码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 冻结和解冻操作是相对的。 ...
码激活接口
接口用途 当需要激活码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 已撤销(作废)/使用的码不能转换为其他状态。 action CodeSt...
同步批量码作废
接口用途 多码批量作废时，调用此接口 接口说明 一次可以多码作废,一次最多20个码。 action SyncBatchCodeUpdate 请求参数，CHANNEL===>WHALE...
码信息更新接口
接口用途 当需要对指定码的部分信息进行更新时，调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeDetailUpdate 请求参数，...
码信息查询
接口用途 当需要查询某个指定码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeQuery 请求参数，CHANNEL===...
批量码核销
接口用途 多码批量核销时，调用此接口 接口说明 一次可以多码核销,一次最多10个码。 action BatchCodesVerify 请求参数，CHANNEL===>WHALE 字...
批量码核销查询
接口用途 批量核销接口调用超时对核销结果未知道，可以调用此接口来查询核销结果 接口说明 此接口默认支持查询当日内核销交易 也可传参originalDate查询指定日核销交易 actio...
批量码核销撤销
接口用途 多码批量核销订单撤销时或订单中部分码撤销，调用此接口。 接口说明 撤销批量核销订单，调用前请确认订单是否符合撤销条件。 action BatchCodeVerifyVoid ...
测试apimock同步
[yapi_interface]617[/yapi_interface]
查询码信息查询
接口用途 当需要查询某个指定码时，取码方调用此接口 接口说明 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 action CodeQueryBySearchCode 请求参数，CHAN...
运营管理类接口
箱本包处理类接口
激活查询
接口用途 激活前查询是否可以激活 （实际场景 激活前和激活后都会查询，如果上送券码都是激活返回已激活，如果上含未激活返回未激活） action activePreQuery 请求参数，中...
激活
接口用途 激活 action activeVoucher 请求参数，中间件===>易百后台 字段 类型 是否必填 字段意义 备注 traceNo String 是 收银...
激活结果查询
接口用途 激活结果查询 action activeResultQuery 请求参数，中间件===>易百后台 字段 类型 是否必填 字段意义 备注 traceNo Strin...
作废
接口用途 作废，作废后的券不可激活 action delVoucher 请求参数，中间件===>易百后台 字段 类型 是否必填 字段意义 备注 traceNo String...
核销信息以及城市范围查询
接口用途 核销信息以及城市范围查询 action queryVerifyInfo 请求参数，中间件===>易百后台 字段 类型 是否必填 字段意义 备注 traceNo S...
B2B饮料券箱本激活
接口用途 激活 action reelActiveVoucher 请求参数，中间件===>易百后台 字段 类型 是否必填 字段意义 备注 traceNo String 是...
B2B饮料券箱本作废
接口用途 作废，作废后的券不可激活 action reelDelVoucher 请求参数，中间件===>易百后台 字段 类型 是否必填 字段意义 备注 traceNo St...
卡号段激活实体卡券（B2B定制）
接口用途 指定券码号段激活，相同激活订单号直接返回当前状态 action b2b/code/activeByPartNo 请求参数，中间件===>易百后台 字段 类型 是...