概要描述:
收银员使用扫码设备读取用户微信/支付宝APP付款码/银联二维码以后,二维码或条码信息传送至商户收银台,由商户收银台或者商户后台调用该接口发起支付对用户进行收款。
请求URL:
请求参数(O-非必传 ,M-必传,C-选传)
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
agent_no |
服务商编号 |
String |
|
|
M |
merch_no |
海科商户编号 |
String |
海科商户编号 |
|
M |
appid |
公众账号ID |
String |
微信支付时选填:微信分配的公众账号 ID |
|
O |
auth_code |
支付授权码 |
String |
支付授权码 |
|
M |
channel_no |
渠道商商户号 |
String |
微信或者支付宝时使用: 微信分配的渠道商ID;支付宝分配的pid |
|
C |
sub_mch_id |
报备商户编号 |
String |
微信或者支付宝时使用 |
|
C |
out_trade_no |
服务商支付订单号 |
String |
服务商内部订单号(同一服务商下唯一) |
|
M |
total_amount |
交易金额 |
String |
上送银联的交易金额(单位:元) |
|
M |
market_subsidy_amount |
营销补贴金额 |
String |
服务商补贴金额(单位:元) |
|
O |
ledger_type |
分账类型 |
String |
不传默认不分账 REALTIME_SETTLE:实时分账 DELAY_SETTLE:异步分账 |
|
O |
ledger_info |
分账信息 |
JSONARRAY |
分账信息组, ledger_type= REAL_TIME时,该参数必填 |
|
C |
notify_url |
异步通知地址 |
String |
交易成功异步通知地址 |
|
O |
sign |
签名 |
String |
签名 |
|
M |
wx_native_params |
微信原生请求参数 |
JSON |
pay_type=WX时该参数选填 |
|
C |
ali_native_params |
支付宝原生请求参数 |
JSON |
pay_type=ALI时该参数选填 |
|
C |
uniqr_native_params |
云闪付原生请求参数 |
JSON |
pay_type=UNIQR时该参数选填 |
|
C |
分账信息:ledger_info
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
receive_no |
收账商户编号(海科商户编号) |
String |
收账商户编号(海科商户编号) |
|
M |
amt |
分账金额 |
String |
分账金额(单位:元) |
20 |
M |
微信原生请求参数:wx_native_params
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
goods_tag |
微信订单优惠标记 |
String(32) |
微信订单优惠标记,代金券或立减优惠功能的参数 |
|
O |
device_info |
微信设备号 |
String(32) |
终端设备号(门店号或收银设备ID),注意:PC网页或JSAPI支付请传”WEB” |
|
O |
detail |
微信商品详情 |
JSON |
微信单品优惠功能 |
|
O |
微信单品优惠功能:detail
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
cost_price |
订单原价 |
int |
1.商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额。 2.当订单原价与支付金额不相等,则不享受优惠。 3.该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数。 |
608800 |
O |
receipt_id |
商品小票ID |
String(32) |
商家小票ID |
|
O |
goods_detail |
单品列表 |
JSONArray |
单品信息,使用Json数组格式提交 |
|
O |
微信单品列表:goods_detail
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
goods_id |
商品编码 |
String(32) |
由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 |
|
M |
wxpay_goods_id |
微信侧商品编码 |
String(32) |
微信支付定义的统一商品编号(没有可不传) |
|
O |
goods_name |
商品名称 |
String(256) |
商品的实际名称 |
|
O |
quantity |
商品数量 |
int |
用户购买的数量 |
|
M |
price |
商品单价 |
int |
单位为:分。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔100元的订单使用了商场发的纸质优惠券100-50,则活动商品的单价应为原单价-50) |
528800 |
M |
支付宝原生请求参数:ali_native_params
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
operator_id |
商户操作员编号 |
String(28) |
商户操作员编号。新当面资金授权场景必填。 |
yx_001 |
C |
store_id |
商户门店编号 |
String(32) |
商户门店编号。新当面资金授权场景必填。 |
NJ_001 |
C |
terminal_id |
商户机具终端编号 |
String(32) |
商户机具终端编号 |
NJ_T_001 |
C |
goods_detail |
订单包含的商品列表信息 |
JSONArray |
订单包含的商品列表信息,json数组格式。 |
|
O |
extend_params |
业务扩展参数 |
JSON |
业务扩展参数 |
|
O |
支付宝订单包含的商品列表信息:goods_detail
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
goods_id |
商品编号 |
String(32) |
|
apple-01 |
M |
goods_name |
商品名称 |
String(256) |
商品的实际名称 |
|
M |
quantity |
商品数量 |
int |
用户购买的数量 |
|
M |
price |
商品单价 |
int |
商品单价,单位为元 |
2000 |
M |
goods_category |
商品类目 |
String(24) |
商品类目 |
34543238 |
O |
categories_tree |
商品类目树 |
String(128) |
商品类目树,从商品类目根节点到叶子节点的类目id组成,类目id值使用 |
分割 |
|
body |
商品描述信息 |
String(1000) |
商品描述信息 |
|
O |
show_url |
商品的展示地址 |
String(400) |
商品的展示地址 |
|
O |
支付宝业务扩展参数:extend_params
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
sys_service_provider_id |
系统商编号 |
String(64) |
该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的PID |
|
O |
hb_fq_num |
花呗分期数 |
String |
使用花呗分期要进行的分期数 |
|
O |
hb_fq_seller_percent |
花呗分期数手续费 |
String |
使用花呗分期需要卖家承担的手续费比例的百分值,传入100 代表100% |
|
O |
industry_reflux_info |
行业数据回流信息 |
String(512) |
行业数据回流信息, 详见:地铁支付接口参数补充说明 |
|
O |
card_type |
卡类型 |
String(32) |
卡类型 |
|
O |
云闪付原生请求参数:uniqr_native_params
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
pnrInsIdCd |
银联服务商机构号 |
String |
银联服务商机构号,参加银联云闪付活动时上送 |
|
O |
acqAddnData |
收款方附加数据 |
JSON |
收款方附加数据 |
|
O |
(银联二维码)收款方附加数据:acq_addn_data
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
orderInfo |
订单信息 |
JSON |
订单明细内容,如订单标 题、订单描述等 |
|
O |
goodsInfo |
商品信息 |
JSONArray |
商品明细内容 |
|
O |
(银联二维码)订单信息:orderInfo
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
title |
标题 |
String |
标题 |
|
M |
description |
订单描述 |
String |
订单描述 |
|
O |
dctAmount |
可优惠金额 |
String |
当前订单可以参与优惠计算的金额 |
|
O |
addnInfo |
附加信息 |
String |
内容自定义 |
|
O |
(银联二维码)商品信息:goodsInfo
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
id |
标题 |
String |
标题 |
|
M |
name |
商品名称 |
String |
订单描述 |
|
M |
price |
商品单价 |
String |
以分为单位 |
|
M |
quantity |
商品数量 |
String |
商品数量 |
|
M |
category |
商品类目 |
String |
商品类目 |
|
O |
addnInfo |
附加信息 |
String |
附加信息 |
|
O |
请求示例:
{
"agent_no": "IS88888888",
"merch_no": "83388888888",
"auth_code": "287667597892433290",
"out_trade_no": "123456789",
"total_amount": "1",
"sign": "5F154E14FDC459ED5DF628B56F61A609"
}
返回参数说明:
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
return_code |
响应码 |
String |
10000代表成功 |
|
M |
return_msg |
响应信息 |
String |
|
|
M |
agent_no |
服务商编号 |
String |
|
|
M |
merch_no |
海科商户编号 |
String |
海科商户编号 |
|
M |
pay_type |
支付类型 |
String |
WX:微信支付 ALI:支付宝支付 UNIONQR:云闪付 |
|
M |
out_trade_no |
服务商支付订单号 |
String |
|
|
M |
trade_no |
海科支付订单号 |
String |
|
|
M |
voucher_no |
支付凭证号 |
String |
支付成功时有值 |
|
C |
trade_status |
交易状态 |
String |
|
|
M |
sign |
签名 |
String |
签名 |
|
M |
pay_type=WX时返回:
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
appid |
公众账号ID |
String |
调用接口提交的公众账号 ID |
|
M |
openid |
用户标识 |
String |
appid 下的唯一标识 |
|
M |
bank_type |
付款银行 |
String |
银行类型。采用字符串类型的银行识 |
|
M |
cash_fee |
现金支付金额 |
int |
订单现金支付金额 |
|
M |
settlement_total_fee |
应结订单金额 |
int |
当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。 |
|
M |
coupon_fee |
代金券金额 |
String |
“代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额 |
|
M |
promotion_detail |
优惠功能 |
JSON |
优惠功能信息 |
|
M |
微信优惠功能promotion_detail:
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
promotion_id |
券ID |
String |
券或者立减优惠id |
|
M |
name |
优惠名称 |
String |
优惠名称 |
|
O |
scope |
优惠范围 |
String |
GLOBAL- 全场代金券 SINGLE- 单品优惠 |
SINGLE |
O |
type |
优惠类型 |
String |
COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致) DISCOUNT- 优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致 |
DISCOUNT |
O |
amount |
优惠券面额 |
int |
用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额) |
5 |
O |
activity_id |
活动 ID |
String |
在微信商户后台配置的批次 ID |
931386 |
O |
wxpay_contribute |
微信出资 |
int |
特指由微信支付商户平台创建的优惠,出资金额等于本项优惠总金额,单位为分 |
0 |
O |
merchant_contribute |
商户出资 |
int |
特指商户自己创建的优惠,出资金额等于本项优惠总金额,单位为分 |
0 |
O |
other_contribute |
其他出资 |
int |
其他出资方出资金额,单位为分 |
5 |
O |
goods_detail |
单品列表 |
JSONArray |
单品信息 |
|
O |
微信单品列表:goods_detail
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
goods_id |
商品编码 |
String(32) |
由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 |
|
M |
goods_remark |
商品备注 |
String(128) |
goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。 |
|
O |
discount_amount |
商品优惠金额 |
int |
单品的总优惠金额,单位为:分 |
|
M |
quantity |
商品数量 |
int |
用户购买的数量 |
|
M |
price |
商品价格 |
int |
单位为:分。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔100元的订单使用了商场发的纸质优惠券100-50,则活动商品的单价应为原单价-50) |
528800 |
M |
pay_type=ALI时返回:
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
receipt_amount |
实收金额 |
String |
实收金额 |
|
M |
buyer_pay_amount |
买家付款的金额 |
String |
买家付款的金额 |
|
O |
buyer_user_id |
买家在支付宝的用户id |
String |
买家在支付宝的用户 id |
|
M |
fund_bill_list |
交易支付使用的资金渠道 |
JSONARRAY |
交易支付使用的资金渠道 |
|
M |
mdiscount_amount |
商家优惠金额 |
String |
商家优惠金额 |
|
O |
discount_amount |
平台优惠金额 |
String |
平台优惠金额 |
|
O |
discount_goods_detail |
单品券优惠的商品优惠信息 |
String |
本次交易支付所使用的单品券优惠的商品优惠信息 |
|
O |
voucher_detail_list |
优惠信息 |
JSONARRAY |
本交易支付时使用的所有优惠券信息 |
|
O |
支付宝交易支付使用的资金渠道:fund_bill_list
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
fund_channel |
交易使用的资金渠道 |
String(32) |
交易使用的资金渠道 |
|
M |
bank_code |
银行卡支付时的银行代码 |
String(10) |
银行卡支付时的银行代码 |
|
O |
amount |
该支付工具类型所使用的金额 |
Double |
该支付工具类型所使用的金额 |
|
M |
real_amount |
渠道实际付款金额 |
Double |
渠道实际付款金额 |
|
M |
fund_type |
渠道所使用的资金类型 |
String(32) |
目前只在资金渠道 (fund_channel) 是 银 行 卡 渠 道(BANKCARD)的情况下才返回该信息: DEBIT_CARD:借记卡 CREDIT_CARD:信用卡 MIXED_CARD:借贷合一卡 |
|
O |
支付宝优惠信息:voucher_detail_list
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
id |
券id |
String(32) |
券id |
|
M |
name |
券名称 |
String(64) |
券名称 |
|
M |
type |
券类型 |
String(32) |
当 前 有 三 种 类 型 : ALIPAY_FIX_VOUCHER - 全场代金券 ALIPAY_DISCOUNT_VOUCHER-折扣券 ALIPAY_ITEM_VOUCHER-单品优惠 注:不排除将来新增其他类型 的可能,商家接入时注意兼容性避免硬编码 |
|
M |
amount |
优惠券面额 |
Double |
它应该会等于商家出资加上其他出资方出资 |
|
M |
merchant_contribute |
商家出资 |
Double |
商家出资(特指发起交易的商家出资金额) |
|
O |
other_contribute |
其他出资方出资金额 |
Double |
其他出资方出资金额,可能是支付宝可能是品牌商,或者其他方,也可能是他们的一起出资 |
|
O |
memo |
优惠券备注信息 |
String(256) |
优惠券备注信息 |
|
O |
template_id |
券模板 id |
String(64) |
券模板 id |
|
O |
other_contribute_detail |
优惠券的其他出资方明细 |
String(32) |
优惠券的其他出资方明细 |
|
O |
contribute_type |
出资方类型 |
String(32) |
出资方类型,如品牌商出资、支付宝平台出资等 |
|
M |
contribute_amount |
出资方金额 |
Double |
出资方金额 |
|
M |
purchase_buyer_contribute |
券实际购买付款金额 |
Double |
如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时用户实际付款的金额 |
|
O |
purchase_merchant_contribute |
券实际购买时商户优惠金额 |
Double |
如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时商户优惠的金额 |
|
O |
purchase_ant_contribute |
券实际购买时平台优惠金额 |
Double |
如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时平台优惠的金额 |
|
O |
pay_type=UNIQR时返回:
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
couponInfo |
优惠信息 |
JSONARRAY |
优惠信息 |
|
O |
云闪付优惠信息couponInfo
参数 |
参数名称 |
类型 |
参数说明 |
样例 |
可空 |
spnsrId |
出资方 |
String |
银联作为出资方:固定填写00010000;付款方作为出资方:填写 8 位付款方机构代码商户作为出资方:填写 15 位商户代码(银联商户号)。 |
|
M |
offstAmt |
优惠金额 |
String |
以分为单位 |
|
M |
返回示例:
{
"agent_no": "IS88888888",
"store_no": "83388888888",
"pay_type": "ALI",
"out_trade_no": "123456789",
"trade_no": "AL88888888",
"trade_status": "1",
"return_code": "10000",
"return_msg": "成功",
"receipt_amount": "88.88",
"buyer_pay_amount": 8.88,
"fund_bill_list": [
{
"fund_channel": "ALIPAYACCOUNT",
"amount": 10,
"real_amount": 11.21
}
],
"buyer_user_id": "2088101117955611",
"mdiscount_amount": "88.88",
"discount_amount": "88.88",
"discount_goods_detail": "[{\"goods_id\":\"STANDARD1026181538\",\"goods_name\":\"雪碧\",\"discount_amount\":\"100.00\",\"voucher_id\":\"2015102600073002039000002D5O\"}]",
"voucher_detail_list": [
{
"id": "2015102600073002039000002D5O",
"name": "XX超市5折优惠",
"type": "ALIPAY_FIX_VOUCHER",
"amount": 10,
"merchant_contribute": 9,
"other_contribute": 1,
"memo": "学生专用优惠",
"template_id": "20171030000730015359000EMZP0",
"purchase_buyer_contribute": 2.01,
"purchase_merchant_contribute": 1.03,
"purchase_ant_contribute": 0.82
}
],
"sign": "1032A57E96E4048B27EC2A5C3CE5E663"
}
文档更新时间: 2024-01-12 16:04 作者:陈文