支付业务API

订单支付

接口用途

用户展示付款码由店员使用扫码设备读取付款码信息上送

接口地址

/payment/tradePay

请求参数

参数名
 说明 类型 是否必填 备注
bizContent traceNo 交易流水号 String(32) 是 同一商户全局唯一，用于标识唯一交易
paymentChannelId 支付渠道ID String(32) 否 当收款方需要指定支付渠道时填值(由易百分配)
merOrderNo 商户订单号 String(32) 是 同一商户全局唯一，用于关联收银机订单号
orderAmount 订单原始金额 Number 否 单位分，收银前端原始点单金额
totalAmount 待支付总金额 Number 是 单位分，收银前端已优惠过剩下要支付的金额
deviceNo 设备号 String(32) 是 收银机具终端编号
storeId 商户门店编号 String(32) 是 商户门店编号
storeName 商户门店名称 String(256) 是 商户门店名称
returnOptions 返回选项 String[](300) 否 需与易百技术约定后启用
goodsTag 订单优惠标记 String(32) 否 特殊活动标记，需与易百技术约定后启用
authCode 付款码 String(32) 是
subject 订单标题 String(256) 是
orderTime 订单创建时间 String(19) 是 yyyy-MM-dd HH:mm:ss
notifyUrl 支付回调地址 String(200) 否
goodsDetailList 订单商品明细 List 否
               |__ gid 商品编号 String(32) 是
               |__ gname 商品名称 String(256) 是
               |__ quantity 商品数量 Number 是
               |__ price 商品价格 Number 是 单位分
               |__ category 商品类目 String(32) 是

请求示例

"bizContent": {
    "traceNo": "20240710112246541_11130101",
    "merOrderNo": "0007525202407100000835",
    "totalAmount": 3300,
    "deviceNo": "83520001",
    "storeId": "111301",
    "goodsTag": "",
    "authCode": "132951513806421759",
    "subject": "中-冰美式",
    "notifyUrl": "",
    "goodsDetailList": [
        {
            "gid": "010403",
            "gname": "中-冰美式",
            "quantity": 1,
            "price": 3300,
            "category": "2"
        }
    ]
}

返回参数

参数名
 说明 类型 是否必填 备注
data
 payChannel 支付渠道 String(32) 是 wxpay微信；alipay支付宝；dongfu东福随心兑
transactionNo 易百交易号 String(32) 是
paymentNo 收单机构交易号 String(40) 否
traceNo 交易流水号 String(32) 是 按请求原样下发
transTime 交易时间 String(19) 是 yyyy-MM-dd HH:mm:ss
account 支付账号 String(40) 否
openId 用户唯一标识 String(128) 否
totalAmount 交易总金额 Number 是 单位分，按请求原样下发
receiptAmount 实收金额 Number 是 单位分
mdiscountAmount 商家优惠金额 Number 否 单位分
discountAmount 平台优惠金额 Number 否 单位分
payAmount 用户付款金额 Number 是 单位分
invoiceAmount 给用户可开发票金额 Number 是 单位分
storeName 交易门店名称 String(200) 是
voucherDetailList 交易支付所用优惠券信息 List 否
               |__ activityId 活动ID或券模板ID String(32) 否
               |__ id 券ID String(32) 是
               |__ name 券名称 String(64) 是
               |__ type 券类型 String(32) 是
               |__ amount 券面额 Number 是 单位分
               |__ merchantContribute 商家出资 Number 否 单位分
               |__ otherContribute 其他出资方 Number 否 单位分
               |__ purchaseBuyerContribute 用户购买实付金额 Number 否 单位分
               |__ purchaseMerchantContribute 用户购买商家优惠金额 Number 否 单位分
               |__ purchaseAntContribute 用户购买平台优惠金额 Number 否 单位分

返回示例

{
	"data": {
		"payChannel": "wxpay",
		"transactionNo": "",
		"paymentNo": "4200002227202407102297768192",
		"traceNo": "20240710112246541_11130101",
		"transTime": "2024-07-10 11:28:54",
		"account": "",
		"openId": "o2Jh6jtk9v28kSk2GUuyqhtdzUTs",
		"totalAmount": 3300,
		"receiptAmount": 3300,
		"mdiscountAmount": 0,
		"discountAmount": 0,
		"payAmount": 3300,
		"invoiceAmount": 3300,
		"storeName": "xxx昆山首创奥特莱斯店"
	}
}

查询订单

接口用途 

当调用订单支付接口失败、网络超时、交易状态未知时调此接口来查询订单结果信息

接口地址

/payment/query

请求参数

参数名
 说明 类型 是否必填 备注
bizContent traceNo 交易流水号 String(32) 是 全局唯一，用于标识唯一交易
originalTraceNo 原支付流水号 String(32) 是
originalDate 原交易日期 String(8) 否 传入需要查询的原交易日期，不传默认为当天格式为yyyyMMdd

请求示例

"bizContent": {
    "traceNo": "20240710112246541_11140102",
    "originalTraceNo": "20240710112246541_11130101",
    "originalDate": 20240710
}

返回参数

参数名
 说明 类型 是否必填 备注

 

 

 

 

 

 

 

 

data

 payChannel 支付渠道 String(32) 是
transactionNo 易百交易号 String(32) 是
paymentNo 收单机构交易号 String(40) 否
traceNo 交易流水号 String(32) 是 按请求原样下发
transTime 交易时间 datetime 是
account 支付账号 String(40) 否
openId 用户唯一标识 String(128) 否
totalAmount 交易总金额 Number 是 单位分，按请求原样下发
receiptAmount 实收金额 Number 是 单位分
mdiscountAmount 商家优惠金额 Number 否 单位分
discountAmount 平台优惠金额 Number 否 单位分
payAmount 用户付款金额 Number 是 单位分
invoiceAmount 给用户可开发票金额 Number 是 单位分
storeName 交易门店名称 String(200) 是

返回示例

{
	"data": {
		"payChannel": "wxpay",
		"transactionNo": "",
		"paymentNo": "4200002227202407102297768192",
		"traceNo": "20240710112246541_11130101",
		"transTime": "2024-07-10 11:28:54",
		"account": "",
		"openId": "o2Jh6jtk9v28kSk2GUuyqhtdzUTs",
		"totalAmount": 3300,
		"receiptAmount": 3300,
		"mdiscountAmount": 0,
		"discountAmount": 0,
		"payAmount": 3300,
		"invoiceAmount": 3300,
		"storeName": "xxx昆山首创奥特莱斯店"
	}
}

申请退款

接口用途

当用户或商户要进行支付后退款时调用此接口

接口地址

/payment/refund

请求参数

参数名
 说明 类型 是否必填 备注
bizContent traceNo 交易流水号 String(32) 是 全局唯一，用于标识唯一交易
storeId 商户门店编号 String(32) 是
originalTraceNo 原支付流水号 String(32) 是
originalDate 原交易日期 String(8) 否 传入需要退款的原支付交易日期，不传默认为当天，格式为yyyyMMdd
refundAmount 本次退款金额 Number 是 单位分
refundReason 退款原因 String(128) 是

请求示例

"bizContent": {
  "traceNo": "20240906NJ0070101960163503934",
  "storeId": "111301",
  "originalTraceNo": "20240906NJ0070101960163406444",
  "originalDate": "20240906",
  "refundAmount": 13,
  "refundReason": "正常退款"
}

返回参数

参数名
 说明 类型 是否必填 备注
data
 traceNo 交易流水号 String(32) 是 全局唯一，用于标识唯一交易
transactionNo 易百交易号 String(32) 是
refundNo 收单机构退款单号 String(40) 否
transTime 交易时间 datetime 是
refundAmount 退款成功总金额 Number 是 单位分
storeName 交易门店名称 String(200) 是

返回示例

{
    "data": {
        "traceNo": "20240906NJ0070101960163503934",
        "refundNo": "20240906NJ0070101960163406444",
        "transTime": "2024-07-10 11:28:54",
        "refundAmount": 13,
        "storeName": "xxx昆山首创奥特莱斯店"
    }
}