业务参数对象

卡信息

字段 类型 是否必填 字段意义 备注
cardNo String 是 卡号 卡支付类交易时为必填
password String 否 密码 如需要密码时必填，采用金融加密
valid String 否 有效期 卡支付类交易时为必填，格式：YYMM
track1 String 否 第一磁道 采用金融加密
track2 String 否 第二磁道 卡支付类交易时为必填，采用金融加密
track3 String 否 第三磁道 采用金融加密
cardSn String 否 IC卡序列号 卡支付类交易时，如为IC卡则必填
icData String 否 IC卡数据 卡支付类交易时，如为IC卡则必填
cardType String 否 卡类型 具体枚举如下
tc String 否 交易证书 用于确认交易符合相应规则的证书

cardNo加密方法

password加密方法

track1加密方法

track2加密方法

track3加密方法

cardType枚举

00表示刷磁条卡

01表示插入IC卡

02表示非接IC卡

03表示手输卡号

04表示二维码扫描

05表示其他

06表示收银机采集数据

07表示ApplePay

08表示三星Pay

09表示华为Pay

10表示小米Pay

礼品卡信息

字段 类型 是否必填 字段意义 备注
cardNo String 是 卡号 礼品卡号
cardStatus int 是 卡状态
effectStartTime long 否 有效开始时间 时间戳（毫秒数）
expireTime String 否 失效时间 时间戳（毫秒数）
bindSuccessTime String 否 绑定成功时间 时间戳（毫秒数）
lastUseTime String 否 最近使用时间 时间戳（毫秒数）
cardId String 是 礼品卡种ID
cardName String 是 礼品卡名称
cardFaceValue Price 是 卡面值（单位：元，保留两位小数） 后端返回
cardNetValue Price 是 卡净值（单位：元，保留两位小数） 后端返回
cardBalance Price 是 卡余额（单位：元，保留两位小数） 后端返回
extraInfo String 否 附加信息 主要是针对显示用的
状态值 状态名称
0 已用完
11 可使用
20 已过期
21 已作废
81 已经激活未绑定
82 未激活


产品明细

字段 类型 是否必填 字段意义 备注
goodsCategory String 是 商品类别  
goodsId String 是 商品编号  
goodsName String 是 商品名称 用于报表、小票等显示
goodsSpec String 否 商品规格 用于报表、小票等显示
price Price 是 单价 单位：元
quantity Integer 是 数量  
rebateCode String 否 折扣代码 收银机上已设置折扣，则必填,长度大于3位小于32位
activityNo String 否 活动编号 易百后台交易成功，会返回本交易所属的活动编号
memo String 否 备注 易百后台交易成功，会返回部分信息，如电子凭证号码
voucherId String 否 优惠券ID 当有优惠券信息时返回

资金渠道

字段 类型 是否必填 字段意义 备注
channelNo String 是 资金渠道编号
channelName String 是 资金渠道名称
channelAmount Price 是 金额 对应的资金渠道金额
sectionNo String 否 活动编号 活动编号由财务后台分配，和收银机可以进行匹配入机
channelNo channelName 字段意义
user_real_money 用户实际支付 如支付宝余额、余额宝、微信钱包余额、银行卡等
user_balance 用户余额支付 如支付宝余额、余额宝、微信钱包余额等
user_bank_card 用户银行卡余额 使用用户借记卡或贷记卡的余额进行支付
user_credit 用户信用支付 如绑卡活动、支付宝花呗、京东白条等
user_points 用户积分支付 如银行积分、天猫积分、集分宝等
user_points_amount 用户积分对等的金额(RMB) 用户本次支付的积分值除以积分比例得到金额
user_rights 用户权益 商户权益等
user_coupon 用户用券抵扣金额 如支付宝卡包券、银行APP卡包券(等于voucherDetail明细中的所有voucherAmount累加总和)
merchant_benefit 商户提供的优惠 如商户空券，商户折扣等
platform_benefit 平台提供的优惠 如平台折扣，平台补贴等
other_benefit 其他出资方优惠 如银行
ebuy_benefit 易百提供的优惠 如易百折扣，易百补贴等

打印信息

字段 类型 是否必填 字段意义 备注
cardNo64 String 否 卡号前六后四 返回需要打印的卡号前六后四
bank String 否 发卡银行 返回需要打印的发卡银行
bankTid String 否 收单终端号 在银联二维码，嘉联收单时返回
bankMid String 否 收单商户号 在银联二维码，嘉联收单时返回
paymentOrderNo String 否 机构订单号 返回需要打印的机构订单号
paymentUser String 否 机构用户账号 返回需要打印的机构用户账号
pointSale String 否 扣除积分 返回需要打印的扣除积分数量
qrCode1 String 否 打印二维码1 返回需要打印的二维码1
qrCode2 String 否 打印二维码2 返回需要打印的二维码2
qrCode3 String 否 打印二维码3 返回需要打印的二维码3
barCode1 String 否 打印条码1 返回需要打印的条码内容1
barCode2 String 否 打印条码2 返回需要打印的条码内容2
barCode3 String 否 打印条码3 返回需要打印的条码内容3
content String 否 打印内容 返回需要打印的内容，TLV格式，1F为小票title，2F为小票交易类型说明显示
printMode String 否 打印联数 1表示一联，2表示两联，3表示三联

会员信息

字段 类型 是否必填 字段意义 备注
memberId String 是 会员编号  
memberCode String 是 会员卡号  
memberName String 是 会员名称  
memberPhone String 否 会员手机号码  
grade String 否 会员等级  
status String 否 会员状态  
balance Price 否 会员卡余额  
pointBalance Price 否 会员积分余额

权益信息

字段 类型 是否必填 字段意义 备注
snCode String 是 权益编号

结算记录

字段 类型 是否必填 字段意义 备注
activityNo String 是 活动编号  
activityName String 是 活动名称  
productName String 是 产品名称  
customer String 是 结算客户  
isRefund Boolean 是 是否为退款  
volume Integer 是 交易笔数  
totalReceiptAmount Price 是 商户实收金额  
totalAmount Price 是 小计金额

交易记录

字段 类型 是否必填 字段意义 备注
traceNo String 是 原交易收银机流水号 必须包含yyyyMMdd(当天)
paidAmount String 是 支付成功金额  
status String 是 匹配状态 枚举如下

status枚举

活动产品

字段 类型 是否必填 字段意义 备注
activityProductNo String 是 活动产品编号  
activityProductName String 是 活动产品名称  
command String 否 下发交易指令
showOrder String 是 显示顺序 从小到大显示

交易时间戳

字段 类型 是否必填 字段意义 备注
traceNo String 是 原交易收银机流水号 必须包含yyyyMMdd(当天)
send String 是 发送时间 Unix时间戳,单位：秒
recv String 是 接收时间 Unix时间戳,单位：秒

交易记录明细

字段 类型 是否必填 字段意义 备注
action String 是 交易action
traceNo String 是 交易收银机流水号 必须包含yyyyMMdd(当天)
orderNo String 是 易百系统参考号
transDate String 是 交易时间 格式：yyyyMMddHHmmss
returnCode String 是 返回码 00表示交易成功，其他表示失败
returnDesc String 是 返回信息 交易结果描述或错误原因
paidAmount String 是 交易成功金额
activityProductNo String 是 活动产品编号
activityProductName String 是 活动产品名称 活动名称+产品名称
bank String 是 交易机构标识
cardNo64 String 是 卡号或串码
printContent String 是 小票打印数据

功能菜单

字段 类型 是否必填 字段意义 备注
iconUrl String 是 用于功能显示icon图下载URL 变长
title String 是 用于功能名称显示 变长
action String 是 功能对应的后台处理路径 变长
command String 是 用于下发功能所有执行的指令 例如:04|00|请刷磁条卡|1|08|00|暴风雪(中)$HDCP00000000072578|0|
childrenFunc List<function> 否 功能下的子项 变长

图片信息

字段 类型 是否必填 字段意义 备注
displayPicUrl String 是 用于广告显示图片下载URL 变长
linkUrl String 是 用于点击广告图片后要跳转的页面URL 变长

包裹明细

字段 类型 是否必填 字段意义 备注
packId String 是 打包ID 变长
packName String 是 打包名称  
goodsInfoList List<goodsDetail> 是 产品明细

订单信息

字段 类型 是否必填 字段意义 备注
appOrderNo String 是 应用订单号 变长
statusCode String 是 订单状态码 变长
status String 是 订单状态 订单状态汉字描述
orderTime String 是 订单时间 格式HH:mm,用于订单列表页面显示
orderCreateTime String 是 订单时间 格式yyyy-MM-dd HH:mm:ss
orderAmount Price 是 订单金额  
rcptName String 是 收货人  
platformName String 是 平台名称 变长,说明订单是来自百度，美团平台,长度不超过四个汉字
packageDetailList List<packageDetail> 否 订单包裹明细 该节点在调用订单明细接口时才会有数据下发

优惠券明细

字段 类型 是否必填 字段意义 备注
voucherId String 是 优惠券编号
voucherName String 是 优惠券名称 用于报表、小票等显示
voucherType String 是 优惠券类型
voucherAmount Price 是 单价 单位：元
merchantDiscount Price 否 商户优惠金额 单位：元
userDiscount Price 否 用户购券金额 单位：元
platformDiscount Price 否 平台优惠补贴金额 单位：元
otherDiscount Price 否 其他出资方补贴金额 单位：元
voucherCode String 是 优惠券串号

批量核销明细

字段 类型 是否必填 字段意义 备注
code String 是 劵码
status String 是 核销结果返回码 00表示核销成功,其他失败
desc String 是 核销结果描述
paidAmount Price 是 支付成功总金额 单位：元
receiptAmount Price 否 商户实收金额 单位：元
invoiceAmount Price 否 商户开票金额 单位：元
lockTime String 是 锁定时间,单位（秒） 默认：300
afterLock String 是 锁定到期后处理，核销：1，解锁：0 默认：0
exchangeRate Number(8,6) 否 汇率 1外币等于多少人民币
currency String 否 货币类型 例如:CNY
discountCode String 否 折扣编码 由收银机分配，用于入账计折扣类型
discountNum Number 否 固定金额折扣数量 用于入账计折扣类型的数量
tenderCode String 否 支付方式编码 由收银机分配，用于入账计支付方式
activityProductNo String 否 活动产品编号
activityProductName String 否 活动产品名称
goodsDetail List<goodsDetail> 否 折抵产品明细 返回后台已抵扣成功的产品明细
fundChannel List<fundChannel> 否 资金渠道
printDetail Object<printDetail> 否 打印信息 如需要在收银小票上打印信息时必填
memberDetail Object<memberDetail> 否 会员信息 返回本次交易的会员信息
voucherDetail List<voucherDetail> 否 优惠券信息 返回本次交易的优惠券信息

批量核销劵码

字段 类型 是否必填 字段意义 备注
code String 是 劵码  
activityProductNo String 否 活动产品编号
ext String 否 扩展字段

扩展信息

字段 类型 是否必填 字段意义 备注
vUseInfo String 否 劵使用须知
vDiscountDesc String 否 劵优惠说明
vUseRule String 否 劵使用规则
activityProductId String 否 活动产品id
userRealAmount Price 否 用户实付金额 单位元
defaultGoodsId String 否 默认上屏ID产品 id 如果值为空或者goodsDetail的size是1都不支持更换
oriCode String 否 请求对应的原券码
ticketType String 否 券所属类型 -------电子券ticketType----------
ebuy代金券: cashCoupon
ebuy产品券：merchandiseCoupon
ebuy折扣券：discountCoupon
ebuy满减券：fullReduceCoupon
ebuy买赠券：buyGetCoupon
cardSearchCode String 否 现金卡对应的查询码


voucherDetail String 是 易百券相关信息

createTime  String   创建时间

validStart     String  券有效期开始时间
validEnd      String  券有效期结束时间
ticketId        String  券id 511293,

ticketName String 券名
status          String  状态  00

00    可使用    
01    已使用    
02    可使用(一码多次使用时，码还有可用次数)    
03    未激活    未激活的码需调用激活接口才能
04    已冻结    
05    已作废    
06    已过期    
07    未生效    当制码时选择次日生效，核销时会返回该状态
08    不能退款    仅核销场景-不支持核销撤销(根据业务场景配置是否支持隔日和当日核销撤销)
09    券不存在    券码不存在(券码查询、核销、核销撤销)
21    电子凭证不可用    
券码不在有效期

35    码配置异常    
51    改码不存在制码方    
97    报文错误    接口调用参数校验不通过

statusDesc   String 状态描述

faceValue     BigDecimal 面值（分）
activateTime  String 激活时间 (可以为空)
isRefund int 否 查询原消费交易时如发生过退款此时isRefund=1 注意isRefund=1时仅表示消费交易有过退款操作，并不表示消费金额已全部退完
verifyOptions Objetc 否 抖音核销专用返回
invoiceInfo String 否 Costa支付宝企业付开票信息约定返回

[{
        "activityNo": "2014030701",
        "amount": 12.7,
        "isInvoice": true
    },
    {
        "activityNo": "2025020801",
        "amount": 41.3
    }
]

返回如上JSON数组格式，isInvoice=true时表示此金额为开票字段


集点明细

字段 类型 是否必填 字段意义 备注
activityNo String 是 集点活动编号  
points Integer 是 集点点数

签购单信息

字段 类型 是否必填 字段意义 备注
mid String 是 商户编号  
tid String 是 终端编号  
merchantName String 是 商户名称  
acquiere String 是 收单行标识码  
issuer String 是 发卡行标识码  
cardNo String 是 卡号  
batchNo String 是 批次号  
voucherNo String 是 凭证号  
authNo String 否 授权码  
referNo String 是 系统参考号  
date String 是 日期  
expDate String 否 卡有效期  
transType String 是 交易类型 中间件还需根据用卡方式拼接上（括号和括号内的字母）：刷卡:（S）、插卡：（I）、挥卡：（C）、手卡号输：（M）
amount String   交易金额  
wildcard String 否 国际信用卡公司代码  
TC String 否 TC  
ARQC String 否 ARQC  
TVR String 否 TVR  
TSI String 否 TSI  
AID String 否 AID  
ATC String 否 ATC  
APPLAB String 否 APPLAB  
APPName String 否 APPName  
reMark String 是 备注信息 备注信息 LLVAR190 MIS-POS Client负责备注栏信息分行打印，不去管具体信息内容。 要求： 1.每行信息用';'分割。 2．如有中文提示，比如原凭证号，原授权号，则请加上这些信息。 3．重打印标志由MIS-POS Client判断，故EMV-POS不需要 重打印凭证/DUPLICATED 这条备注信息。

机构信息

字段 类型 是否必填 字段意义 备注
loginIndex String 是 对应签到标志的寻位索引  
mid String 否 机构商户号  
tid String 否 机构终端号  
merchantName String 否 机构商户名称  
serviceIp String 否 机构服务IP  
servicePort String 否 机构服务端口  
serviceUrl String 否 机构服务url

电子券包本信息

箱信息：

JSON Key为voucherBox，出现在请求报文中，非必填

字段 类型 是否必填 字段意义 备注
boxId String 是 电子券箱号  
voucherPkg List<voucherPkg> 否 电子券包信息

包信息：

JSON Key为voucherPkg，出现在请求报文中，非必填

字段 类型 是否必填 字段意义 备注
pkgId String 是 电子券包号  
voucherReel List<voucherReel> 否 电子券本信息

本信息：

JSON Key为voucherReel，出现在请求报文中，非必填

字段 类型 是否必填 字段意义 备注
reelId String 是 电子券本号  
codeDetail List<codeDetail> 否 电子券券号

券信息：

字段 类型 是否必填 字段意义 备注
code String 是 电子凭证码  
saleChannelOrderId String 是 取码方制码订单号  
saleChannelName String 是 取码方名称  
sendChannelName String 是 制码方名称  
remainTimes Integer 是 剩余核销次数  
createDate String 是 码创建日期 yyyyMMdd
createTime String 是 码创建时间 yyyyMMddHHmmss
validStart String 否 码有效开始时间 yyyyMMddHHmmss
validEnd String 否 码有效结束时间 yyyyMMddHHmmss
activateDate String 否 激活日期 yyyyMMdd
activateTime String 否 激活时间 yyyyMMddHHmmss
activateShopNo String 否 激活门店  
verifyDate String 否 码核销日期 yyyyMMdd
verifyTime String 否 码核销时间 yyyyMMddHHmmss
status String 是 状态  
statusDesc String 是 状态描述  
cityCheck String 是 劵所在城市是否可用 Y可用N不可用
ticketId String 是 券id  
ticketName String 是 券名称  
activityId String 是 活动id  
activityName String 是 活动名称  
faceValue Number 否 券面值 单位：分
shopNo String 否 核销门店编号  
shopName String 否 核销门店名称
cityName String 是 城市名称 武汉市
cityCode String 是 城市编码 武汉市

账户信息

字段 类型 是否必填 字段意义 备注
memberCode String 是 账号编号 accountType是5时，此字段是券码
accountType String 是 账户类型。1:易百会员ID,2:手机号码,3:支付宝ID, 4:微信OPENID，5：券码（添加）

会员积分

字段 类型 是否必填 字段意义 备注
points String 是 积分总数
deductileAmount String 是 可抵扣金额
validDate String 否 即将过期日期 格式：YYYYMMDDhhmmss
invalidPoints String 否 即将过期积分数 

会员电子券

字段 类型 是否必填 字段意义 备注
voucherType String 是 coupon电子券，rights权益，cashCard现金卡 枚举类型，易百提供
code String 是 码号或卡号  
faceAmount String 是 面值  
validDate String 是 使用有效期 格式：YYYYMMDD-YYYYMMDD
voucherStatus String 是 状态  
voucherStatusDesc String 是 状态描述  
tenderDiscountCode String 否 使用电子券和权益时返回 格式：支付编码｜折扣编码
cardAmount String 否 现金卡剩余金额，使用现金卡时返回  
merchatRealAmount String 否 商户实收金额，使用电子券和权益时返回 特殊字段需与ebuy确认
discountAmount String 否 商户优惠金额，使用电子券和权益时返回 特殊字段需与ebuy确认
userInvoiceAmount String 否 给用户开票的金额  
ebuyInvoiceAmount String 否 给易百开票的金额，使用电子券和权益时返回  
platformCode String 否 平台编码，易百提供（天猫（Tmall），淘宝（TaoBao），拼多多（PDD），京东（JD））  
activityProductNo String 否 活动产品编号  
remainTimes String 否 当前可使用次数，使用电子券和权益时返回  
totalTimes String 否 总使用次数，使用电子券和权益时返回  
voucherScope String 否 商户定制规则使用字段，配置部分原样下发 例如：商户券分类，就餐时间规则，使用条件限制
defaultGoodsId String 否 默认上屏产品 id，多产品时返回  
goodsDetail List<goodsDetail> 否 折抵产品明细

卡券明细

扩展信息-抖音线上核销报文

字段 类型 是否必填 字段意义 备注
verifyToken
 String 是
相同 token的结果幂等，开发者⾃⾏⽣成，⻓度需⼤于 4 字节⼩于 64 字节
poiId
 String 是
核销⻔店信息，核销原⽣券时需要⻔店信息
orderInfo
 OrdeInfo 是
订单信息，若该门店不支持核销则OrdeInfo为空
         
OrdeInfo字段及含义如下        
orderId
 String 是
要核销的券所属订单
  
certificateId
String
 否 券信息
• 团购券和代⾦券返回传certificate_id
 certificateId及timesCardInfo两者必有其一
timesCardInfo
 TimesCard 否 券信息
• 次卡券返回TimesCard结构		  
         
TimesCard字段及含义如下        
code
String
 是
抵扣券ID，对应抖⾳原⽣团购券的certificate_id
  
times
 Integer 是
次卡券必填，代表可核销次数，小于等于0表示次卡已用完