轻量化支付接口
1. 修订记录
修订 |
日期 |
说明 |
作者 |
0.1 |
2021/12/05 |
新接口参数定义 |
张炼 |
0.2 |
2021/12/28 |
扫码接口、支付宝生活号接口新增支付宝上送门店信息参数 |
林竞 |
0.3 |
2021/12/27 |
支持国密 |
王晶 |
0.4 |
2022/03/17 |
新增支付成功异步通知营销相关字段 |
刘雷 |
0.5 |
2022/03/18 |
新增银联259号文条码改造相关字段 |
刘雷 |
0.6 |
2022/05/13 |
新增支付宝刷脸参数相关字段 |
刘雷 |
0.7 |
2022/12/14 |
对反扫码支付接口、支付宝生活号接口新增支付宝业务拓展参数extend_params_channel |
刘军 |
0.8 |
2023/01/09 |
对反扫码支付接口、支付宝生活号接口新增同步响应参数发往渠道流水号channel_send_sn,渠道返回流水号channel_recv_sn |
林竞 |
0.9 |
2023/01/09 |
对微信公众号&小程序接口新增同步响应参数发往渠道流水号channel_send_sn |
林竞 |
1.0 |
2023/01/09 |
对反扫码支付接口、支付宝生活号接口新增花呗分期期数支持3期,新增分期类型fq_type |
林竞 |
2. 业务说明
(1)场景说明
1、轻量化接口包含反扫码接口、行业码接口、微信公众号&小程序接口、支付宝生活号接口
2、反扫接口支持微信反扫、支付宝反扫、银联反扫、苏宁反扫
(2)接口说明
1、传递的计费参数(payee_fee,src_fee)参数小于0,抛出Biz异常
2、传递的计费参数(payee_fee,src_fee)大于交易金额,抛出Biz异常
3、如果收款方计费(payee_fee)和发起方计费(src_fee)都没有传递的话,则进行计费的查询
4、如果收款方计费(payee_fee)和发起方计费(src_fee)有一个传递的话,使用传递的进行计费
5、发起方手续费与发起方手续费收取方式需同时为空或同时不为空;收款方手续费与收款方手续费收取方式需同时为空或同时不为空
6、发起方手续费收取方式与收款方手续费收取方式均支持月结或实时收取
7、如果传递了路由参数(paygate_no),那么按照传递的参数进行路由;如果没有传递路由参数(paygate_no),那么就调用路由接口进行路由
3. 请求地址
4. 反扫码支付
4.1 请求参数说明
4.1.1 公共请求参数
参数 |
类型(长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.barcodepay.light |
partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
notify_url |
String(500) |
Y |
交易成功异步通知到商户的后台地址,http路径支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3,支持TLS1.0、TLS1.1、TLS1.2 |
version |
String(3) |
Y |
版本号3.0/3.1/3.2 /3.4 当前版本3.4 |
tran_type |
String(1) |
N |
交易类型,说明:1或者空:非担保交易,2:担保交易(D0不支持),无特殊需求 不用填此字段 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.1.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
shopdate |
String(8,8) |
Y |
商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
subject |
String(1,250) |
Y |
订单备注 |
total_amount |
Number(10,2) |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。Number(10,2)指10位长度,2位精度 示例值:100 |
currency |
String(3) |
N |
默认CNY(人民币) |
seller_id |
String(1,20) |
Y |
收款商户号(银盛支付生成并下发) |
seller_name |
String(1,50) |
Y |
收款商户号对应商户名称 |
timeout_express |
String(2,6) |
Y |
设置未付款交易的超时时间,一旦超时,该笔交易就会自动被关闭,取值范围:1m~15d。m-分钟,h-小时,d-天。该参数数值不接受小数点,如1.5h,可转换为90m。注意:设置了未付款交易超时时间的情况下,若我司在限定时间内没有收到成功支付通知,则会关闭交易,关闭后该笔交易若付款方支付成功的情况下,会自动原路退款至付款方。示例值:96h 代表96小时后订单自动关闭 |
extend_params |
String(500) |
N |
业务扩展参数,一个json字符串,order_mode订单模式,暂时可选的值为:00 代表购物车模式;seller_list参与分账的收款方信息数组,每个元素包含seller_id收款方银盛支付用户号。实时分账业务,order_mode和seller_list均不能为空,order_mode的值必须为00。示例值:样例8.8 |
extra_common_param |
String(2000) |
N |
公用回传参数 商户自定义数据域,原样返回 |
business_code |
String(1,10) |
Y |
业务代码 ,请联系银盛客户经理获取。注意:业务代码非固定值,不同到账方式需要传不同的业务代码,反扫D0为00510080 |
bank_type |
String(7\ |
9) |
Y |
二维码行别,微信-1902000,支付宝-1903000,中国银联-9001002,苏宁-1905000 |
scene |
String(1,32) |
N |
支付场景,条码支付取值:bar_code,声波支付取值:wave_code 注:当bank_type域为支付宝-1903000时,此域为必填字段。 |
auth_code |
String(1,128) |
Y |
扫码支付授权码(APP中的付款码),设备读取用户展示的条码或者二维码信息 |
device_info |
String(8) |
N |
终端设备号。注:当bank_type域为中国银联-9001002时,此域为必填字段。银联反扫必传8位整数 |
sub_merchant |
SubMerchantInfo |
N |
二级商户信息,反扫D0不支持, Json格式,暂包括merName、merShortName、merAddr、telephone、merNo、category、mrchntCertId |
consignee_info |
ConsigeeInfo |
N |
收货人信息json格式,反扫D0不支持 |
appid |
String(32) |
N |
微信分配的子商户公众号账号ID 示例值:wx8888888888888888 |
limit_credit_pay |
String(2) |
N |
是否限制信用卡。值为1表示禁用信用卡,0或为空表示不限制 |
hb_fq_num |
String(2) |
N |
花呗分期期数,仅在支付宝支付的时候生效,目前期数支持3,6,12,反扫D0暂不支持 |
|
fq_type |
String(2) |
N |
分期类型,值为00表示花呗分期,值01表示信用卡分期。不填默认为花呗分期 |
allow_repeat_pay |
String(2) |
N |
是否允许多次支付,Y:允许;N:不允许(当参数为空或者Y时,如果该笔订单交易状态非成功状态时,支持选择其他支付方式继续付款, 当参数为N时表示当该笔订单交易状态为失败状态时,不支持选择其他支付方式继续付款) |
fail_notify_url |
String(190) |
N |
失败通知地址(交易状态为失败时,银盛支付服务器主动通知商户网站里指定的页面http路径,支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3)注:只有不允许重复支付的交易才会通知,反扫D0暂不支持 |
detail |
String(6000) |
N |
微信商品详情,单品优惠活动,反扫D0暂不支持,示例值:样例8.1 |
aliGoodsDetails |
List |
N |
支付宝营销单品详情列表,反扫D0暂不支持 |
submer_ip |
String(16) |
N |
子商户ip,反扫D0暂不支持 |
paygate_no |
String(1-32) |
N |
扫码交易路由,如下:(900000001)银联-支付宝 , (9000010)银联-微信 , (10810001)银联扫码-银联云闪付 , (10010001)网联-微信 ,(10000012)网联-支付宝 |
payee_fee |
Number(10,2) |
N |
收款方费用 |
src_fee |
Number(10,2) |
N |
发起方费用 |
src_fee_flag |
String(1-8) |
N |
发起方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
payee_fee_flag |
String(1-8) |
N |
收款方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
store_id |
String(32) |
N |
商户门店编号 |
alipay_store_id |
String(32) |
N |
支付宝的店铺编号 |
operator_id |
String(28) |
N |
商户操作员编号 |
union_qrcode_259_params |
UnionQrCodeBaseRequest |
N |
银联259号文条码改造字段,json格式 |
terminal_params |
String |
N |
支付宝刷脸支付时,商户传入设备终端字段,json格式 |
business_params |
String |
N |
支付宝刷脸支付时,商户传入的业务参数,应用于安全,营销参数等直接传入场景,json格式 |
extend_params_channel |
String |
N |
支付宝业务拓展参数json格式 示例值:{"food_order_type":"qr_order"} |
4.1.3 二级商户 SubMerchantInfo
参数 |
类型(字节长度) |
必填 |
参数说明 |
merName |
String(50) |
N |
二级商户名称,支持25个中文 |
merShortName |
String(50) |
N |
二级商户简称,支持25个中文 |
merAddr |
String(200) |
N |
二级商户地址,支持100个中文 |
telephone |
String(13) |
N |
固定电话/手机号码二选一 |
merNo |
String(32) |
N |
二级商户编号 |
category |
String(20) |
N |
类目,按附件内容输入类目编号 |
mrchntCertId |
String(15\ |
18) |
N |
身份证号,只支持身份证格式(如果签名方式为RSA,则用DES加密,密钥为商户号前8位,不足8位在商户号前补空格;如果签名方式为SM,则用SM加密) |
4.1.4 收货人信息 ConsigeeInfo
参数 |
类型(字节长度) |
必填 |
参数说明 |
consigneeName |
String(150) |
N |
收货人姓名 |
consigneeAddr |
String(200) |
N |
收货地址 |
transportationInfo |
String(200) |
N |
物流配送信息(物流名称+订单号) |
commodityName |
String(150) |
N |
商品名称 |
commodityNumber |
String(10) |
N |
商品数量, |
4.1.5 微信营销 detail
参数 |
类型(字节长度) |
必填 |
参数说明 |
cost_price |
double |
N |
订单原价,整数不超过14位,小数不超过2位,单位元 10.50 |
receipt_id |
String(32) |
N |
商品小票ID,长度不能超过32位 Ys001001 |
goods_detail |
List |
Y |
商品列表 |
4.1.5.1 goods 微信商品列表
参数 |
类型(字节长度) |
必填 |
参数说明 |
goods_id |
String(32) |
Y |
商户商品编码,由半角的大小写字母,数字,下划线,中划线中的一种或者几种组成,长度不能超过32位 Shouji_abcef_001-001 |
wxpay_goods_id |
String(32) |
N |
微信支付定义的统一商品编号,长度不能超过32 1001 |
goods_name |
String(256) |
N |
商品的实际名称,长度不能超过256 手机 |
quantity |
int(10) |
Y |
数量,只能是正整数 1000 |
price |
Double |
Y |
商品单价,单位元,整数部分不能超过12位,小数不能超过2位 例 100.20 |
4.1.6 支付宝营销 AliGoodsDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
goods_id |
String(32) |
Y |
商品编号 apple-01 |
alipay_goods_id |
String(32) |
N |
支付宝定义的统一商品编号 20010001 |
goods_name |
String(256) |
Y |
营销商品名称 ipad |
quantity |
String(10) |
Y |
营销商品数量 不超过10位的正整数 |
price |
String(12) |
Y |
营销商品单价 [0,999999999] 左闭右闭区间,小数点两位 999999998.99 |
goods_category |
String(24) |
N |
支付宝商品类目 34543238 |
categories_tree |
String(128) |
N |
支付宝商品类目树,从商品类目根节点到叶子 节点的类目 id 组成,类目 id 值使用,用\ |
分隔 例 124868003\ |
126232002\ |
126252004 |
body |
String(1000) |
N |
营销商品描述 |
show_url |
String(400) |
N |
营销商品展示地址 |
4.1.7 银联259号文条码改造字段 UnionQrCodeBaseRequest
参数 |
类型(字节长度) |
必填 |
参数说明 |
terminal_no |
String(8) |
N |
终端号 |
terminal_type |
String(2) |
N |
终端类型(线下交易场景必填) |
serial_num |
String(50) |
N |
终端序列号 |
network_license |
String(5) |
N |
银行卡受理终端产品入网认证编号 |
app_version |
String(5) |
N |
终端应用程序的版本号 |
terminal_gps |
String(32) |
N |
交易设备位置信息 |
terminal_ip |
String(8) |
N |
交易设备的IP |
encryp_rand_num |
String(10) |
N |
加密随机因子 |
secret_text |
String(16) |
N |
密文数据 |
4.2 响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
4.2.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_barcodepay_light_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
4.2.2 业务响应参数
参数 |
类型(长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(32) |
Y |
商户系统生成的订单号 6843192280647118 |
trade_no |
String(30) |
N |
银盛支付交易流水号 |
trade_status |
String |
Y |
交易状态,成功状态的值: TRADE_SUCCESS 示例值:附录9.1 |
trade_status_ext |
String |
N |
交易扩展状态, 支付中可参考此状态,示例值:附录9.2 |
total_amount |
Number |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 示例值:100 |
account_date |
String(19) |
N |
银盛入账日期,格式"yyyy-MM-dd" 示值值:2017-05-01 |
openid |
String(128) |
N |
子商户appid下用户唯一标识 |
sub_msg |
String(50) |
N |
返回状态描述 参数格式校验错误 |
coupon_Info |
String(100) |
N |
银联优惠信息:coupon_Info优惠信息活动对象为多个时,coupon_Info中就有多方优惠信息spnsrId出资方,值为1时银联出资,值为2时付款方出资,值为3时商户出资offstAmt优惠金额 示例值:样例8.5 |
settlement_amount |
Number(10,2) |
N |
结算金额 示例值:100 |
is_discount |
String |
N |
是否参与优惠(总) Y\ |
N 示例值:Y |
total_discount _fee |
Double(10,2) |
N |
总优惠手续费 示例值:10.00 |
total_discount |
double(10,2) |
N |
总优惠金额 示例值:100.00 |
extra_common_param |
String(2000) |
N |
商户自定义数据域,原样返回 123456789 |
wxpay_coupon_info |
String |
N |
微信营销信息,详细信息是一个json串,交易成功时返回 示例值:样例8.2 |
wxpay_coupon_good_detail |
List |
N |
微信营销活动单品列表 json 组 示例值:样例8.3 |
alipay_coupon_info |
String(4000) |
N |
支付宝营销渠道响应优惠信息 JSON字符串 |
alipay_coupon_good_detail |
String(4096) |
N |
支付宝营销渠道响应商品详情信息 JSON字符串 |
pay_success_time |
String(19) |
N |
支付完成时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
buyer_user_id |
String(128) |
N |
支付宝用户Uid |
card_type |
String |
N |
credit:信用卡debit:借记卡 示例值:credit |
preferential_amount |
Double |
N |
优惠金额 示例值:样例1.2 |
preferential_fee |
Double |
N |
优惠手续费 示例值:样例0.02 |
marketing_rule_json |
String |
N |
营销规则 json |
channel_send_sn |
String(50) |
N |
发往渠道流水号 |
channel_recv_sn |
String(50) |
N |
渠道返回流水号 |
4.2.3 微信营销 wxpay_coupon_info
参数 |
类型(字节长度) |
必填 |
参数说明 |
fee_type |
String(16) |
N |
标价币种,默认CNY |
total_fee |
double |
Y |
标价金额,订单总金额,单位为元 12.00 |
cash_fee_type |
String(16) |
N |
现金支付币种,默认CNY |
cash_fee |
double |
Y |
现金支付金额 :订单现金支付金额(即客户实际付款金额),单位元 1.01 |
settlement_total_fee |
double |
N |
应结订单金额:当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。单位元 |
coupon_fee |
double |
N |
代金券金额:代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额,单位元 |
ext |
String |
N |
附录字段 |
promotionDetail |
String |
Y |
单品优惠活动,详细信息如下 json |
参数 |
类型(字节长度) |
必填 |
参数说明 |
promotion_id |
String(32) |
Y |
券 ID券或者立减优惠ID 例 109519 |
name |
String(64) |
N |
优惠名称 例 单品惠-6 |
scope |
String(32) |
N |
优惠范围 GLOBAL- 全场代金券;SINGLE- 单品优惠 例 SINGLE |
type |
String(32) |
N |
优惠类型COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致)DISCOUNT- 优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致 例 DISCOUNT |
amount |
double |
Y |
用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 ),单位:元 例 5.00 |
activity_id |
String(32) |
N |
活动 ID,在微信商户后台配置的批次 ID 例 931386 |
wxpay_contribute |
String(32) |
N |
微信出资 特指由微信支付商户平台创建的优惠,出资金额 等于本项优惠总金额,单位为元 例 0.00 |
merchant_contribute |
String(32) |
N |
商户出资 特指商户自己创建的优惠,出资金额等于本项优惠总金额,单位为元 例 0.00 |
other_contribute |
String(32) |
N |
其他出资 其他出资方出资金额,单位为元 例 5.00 |
4.2.4 微信营销明细 wxpay_coupon_good_detail
参数 |
类型(字节长度) |
必填 |
参数说明 |
goods_id |
String(32) |
Y |
商户商品编码 由半角的大小写字母、数字、中划线、下划线中的种或几种组成 例 109519 |
goods_remark |
String(128) |
N |
商品备注 goods_remark 为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。例 1001 |
discount_amount |
double |
Y |
商品优惠金额 单品的总优惠金额,单位为元 例 1.00 |
quantity |
Int |
Y |
商品数量 用户购买的数量 例 11 |
price |
double |
Y |
商品价格 单位为:元。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔 100 元的订单使用了商场发的纸质优惠券 100-50,则活动商品的单价应为原单价-50) 例 5288.00 |
promotionId |
String(32) |
Y |
券或者立减优惠id 关联 promotionDetail.promotion_id 例 456789 |
4.2.5 支付宝营销 alipay_coupon_info
参数 |
类型(字节长度) |
必填 |
参数说明 |
total_amount |
double |
Y |
订单金额 单位为元 |
receipt_amount |
double |
Y |
商户实收金额 商家在交易中实际收到的款项, 单位为元 |
buyer_pay_amount |
double |
Y |
用户实付金额 用户在交易中支付的金额,单位为元。 |
invoice_amount |
double |
Y |
开票金额 用户在交易中支付的可开具发票的金额 |
point_amount |
double |
Y |
集分宝支付金额 使用集分宝付款的金额 |
fund_bill_list |
List |
Y |
支付金额信息 |
voucher_detail_list |
List |
N |
本交易支付时使用的所有优惠券信息 |
gmt_payment |
String |
Y |
交易支付时间 2014-11-27 15:45:57 |
4.2.5.1 AlipayTradeFundBill
参数 |
类型(字节长度) |
必填 |
参数说明 |
fund_channel_str |
String(32) |
Y |
资金渠道 参考 (支付渠道代码) ALIPAYACCOUNT |
bank_code |
String(20) |
N |
银行卡支付时的银行代码 CEB |
amount |
double |
Y |
该支付类型所使用的金额 例 10 |
real_amount |
double |
N |
渠道实际付款金额 例 11.21 |
fund_type_str |
String |
N |
集分宝支付金额 |
4.2.5.2 VoucherDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
id |
String(32) |
Y |
券 id2015102600073002039000002D5O |
name |
String(64) |
Y |
券名称 XX 超市 5 折优惠 |
type_str |
String(32) |
Y |
券类型 ALIPAY_FIX_VOUCHER 参考 券类型 |
amount |
double |
Y |
优惠券面值 会等于商家出资加上其他出资方出资 |
merchant_contribute |
double |
N |
商家出资 |
other_contribute |
double |
N |
其他出资方出资金额 |
memo |
String(256) |
N |
优惠券备注信息 学生专用优惠 |
template_id |
String(64) |
N |
卷模板id 20171030000730015359000EMZP0 |
other_contribute_detail |
List |
N |
优惠券的其他出资方明细 |
purchase_buyer_contribute |
double |
N |
用户在购买这张券时用户实际付款的金额 |
purchase_merchant_contribute |
double |
N |
用户在购买这张券时商户优惠的金额 |
purchase_ant_contribute |
double |
N |
用户在购买这张券时平台优惠的金额 |
4.2.5.2.1 ContributeDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
contribute_type |
String |
Y |
出资方类型,如品牌商出资、支付宝平台出资等 BRAND |
contribute_amoun |
double |
Y |
出资方金额 8.00 |
4.2.6 支付宝营销明细 alipay_coupon_good_detail
参数 |
类型(字节长度) |
必填 |
参数说明 |
id |
String(64) |
Y |
记录编号,唯一标识 |
tradesn |
String(30) |
Y |
银盛交易流水 |
seq |
Integer(4) |
Y |
银盛交易流水序列号 |
createtime |
String |
Y |
创建时间 2014-11-27 15:45:57 |
wxpayGoodsId |
String(32) |
N |
渠道单品标识 |
goodsName |
String(256) |
N |
营销单品名称 |
goodsId |
String(32) |
Y |
营销单品标识 |
goodsRemark |
String(256) |
N |
营销单品备注 |
quantity |
NUMBER(10) |
N |
营销单品数量 |
price |
NUMBER(15,4) |
N |
营销单品价格 |
type |
String(32) |
N |
记录类型 参考 下表类型 |
discountAmount |
NUMBER(15,4) |
Y |
抵扣金额 |
goodsDetailJson |
String(3000) |
N |
单品营销参数JSON字符串 |
type参数说明:WXREQ”:微信单品营销请求;“WXRESP”:微信单品营销渠道响应;“ALIREQ”:支付宝单品营销请求;“ALIRESP”:支付宝单品营销渠道响应;
goodsDetailJson参数说明:type为WXREQ/ALIREQ请求类型时,为请求时传入值。type为WXRESP/ALIRESP时为渠道返回的响应值
4.2.6.1 type为“ALIRESP”时响应参数goodsDetailJson
参数 |
类型(字节长度) |
必填 |
参数说明 |
good_id |
String(32) |
Y |
商品的编号 |
discount_amount |
double |
Y |
抵扣金额 |
voucher_id |
String(32) |
Y |
劵id |
4.2.6.2 type为“WXRESP”时响应参数goodsDetailJson
参数 |
类型(字节长度) |
必填 |
参数说明 |
goods_id |
String |
Y |
商品编码 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 |
goods_remark |
String |
N |
商品备注 goods_remark 为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。 1001 |
discount_amoun |
double |
Y |
商品优惠金额 单品的总优惠金额,单位为:元 |
quantity |
int |
Y |
优惠类型 用户购买的数量 |
price |
double |
Y |
商品价格 单位为:元。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔 100 元的订单使用了商场发的纸质优惠券 100-50,则活动商品的单价应为原单价-50) |
4.2.6.3 type为“WXREQ”时响应参数goodsDetailJson
参数 |
类型(字节长度) |
必填 |
备注 |
goods_id |
String |
Y |
商品编码 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 |
wxpay_goods_id |
String |
N |
微信侧商品编号 |
goods_name |
String |
N |
商品名称 |
quantity |
int |
Y |
商品数量 用户购买的数量 |
price |
double |
Y |
商品价格 单位为:元 |
promotionId |
String |
Y |
券id 45678 |
4.2.6.4 type为“ALIREQ”时响应参数goodsDetailJson
参数 |
类型(字节长度) |
必填 |
样例 |
goods_id |
String(32) |
Y |
商品的编号 apple-01 商品 SKU 编码;卷配置中, 可优惠商品编码中配置的编码 |
alipay_goods_id |
String(32) |
N |
支付宝定义的统一商品编号 |
goods_name |
String(256) |
Y |
商品名称 ipad |
quantity |
int(10) |
Y |
商品数量 1 |
price |
double |
N |
商品单价,单位为元 100.00 |
goods_category |
String(24) |
N |
商品类目 34543238 |
categories_tree |
String(128) |
N |
商品类目树,从商品类目根节点到叶子节点的类目id组成,类目id值使用|分割124868003\ |
126232002\ |
126252004 |
body |
String(1000) |
N |
商品描述信息 特价手机 |
show_url |
String(400) |
N |
商品的展示地址 |
4.3 交易成功异步通知
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过系统程序控制客户端页面自动跳转的方式通知给商户网站。这些处理结果数据就是页面跳转同步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 默认值 directpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户系统生成的订单号 示例值:6843192280647118 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。100 |
trade_no |
String(20) |
N |
银盛支付交易流水号。 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED等具体详情看下文中的交易状态详解 |
account_date |
String(10) |
N |
入账的时间,格式"yyyyMMdd" 20140724 |
openid |
String(128) |
N |
子商户appid下用户唯一标识 |
payer_fee |
Number |
N |
该笔订单的付款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 1.00 |
payee_fee |
Number |
N |
该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。1.00 |
partner_fee |
Number |
N |
该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。1.00 |
fee |
Number |
N |
该笔订单的手续费总和(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。1.00 |
coupon_info |
String |
N |
JSON字符串,银联营销渠道响应优惠信,version小于3.6版本为List的JSON字符串,3.6版本(含)以上为CouponInfo的JSON字符串 |
settlement_amount |
Number |
N |
结算金额 100 |
channel_send_sn |
String(50) |
N |
发往渠道流水号 12345678a |
paygate_no |
String(16) |
N |
支付网关编号 10000 |
channel_recv_sn |
String(50) |
N |
渠道返回流水号 12345678a |
card_type |
String |
N |
卡类型credit:信用卡debit:借记卡 |
buyer_user_id |
String |
N |
支付宝用户Uid |
buyer_logon_id |
String |
N |
该字段于2023-9-1已不支持使用,请使用buyer_id对接,如有疑问请咨询银盛技术支持! |
payer_bank_account_no |
String |
N |
银联云闪付款方账号 |
is_discount |
String |
N |
是否参与优惠,Y/N(汇总) |
total_discount_fee |
double |
N |
参考优惠手续费(汇总) 10.00 |
total_discount |
double |
N |
参考优惠金额(汇总) 100.00 |
extra_common_param |
String |
N |
公用回传参数 商户自定义数据域 ,原样返回 123456789 |
wxpay_coupon_info |
String |
N |
微信优惠活动优惠明细 Json 参考 附录及定义 |
wxpay_coupon_good_detail |
List |
N |
微信优惠活动单品信息 Json 参考 附录及定义 |
alipay_trx_resp_coupon_info |
String |
N |
支付宝优惠信息,版本3.5及以上支持 |
ali_merchant_amount |
String |
N |
支付宝商家优惠金额,版本3.5及以上支持 |
ali_platform_dis_amount |
String |
N |
支付宝优惠金额,版本3.5及以上支持 |
ali_goods_details |
List |
N |
支付宝营销单品信息,List JSON字符串 |
pay_success_time |
String |
N |
支付完成时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 版本号3.8及以上支持 |
preferential_amount |
Number |
N |
营销优惠金额 版本3.9及以支持 示例值:样例1.2 |
preferential_fee |
Number |
N |
营销优惠手续费 版本3.9及以支持 示例值:样例0.02 |
marketing_rule_json |
String |
N |
营销规则信息json 版本3.9及以支持 |
4.3.1 微信优惠 wxpay_coupon_good_detail
参数 |
类型(字节长度) |
必填 |
参数说明 |
goods_id |
String |
Y |
商品编码 由半角的大小写字母、数字、中划线、下划线中的种或几种组成 |
goods_remark |
String |
Y |
商品备注 goods_remark 为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。 |
discount_amount |
double |
Y |
商品优惠金额 单品的总优惠金额,单位为元 |
quantity |
Int |
Y |
商品数量 用户购买的数量 |
price |
double |
N |
商品价格 单位为:元。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔 100 元的订单使用了商场发的纸质优惠券 100-50,则活动商品的单价应为原单价-50) |
promotionId |
String |
N |
券id |
4.3.2 支付宝 ali_goods_details
参数 |
类型(字节长度) |
必填 |
参数说明 |
id |
String(64) |
Y |
记录编号,唯一标识 |
tradesn |
String(30) |
Y |
银盛交易流水 |
seq |
Integer(4) |
Y |
银盛交易流水序列号 |
createtime |
Date |
Y |
记录创建时间 |
wxpayGoodsId |
String(32) |
N |
渠道单品标识 |
goodsName |
String(256) |
N |
营销单品名称 |
goodsId |
String(32) |
Y |
营销单品标识 |
goodsRemark |
String(256) |
N |
营销单品备注 |
quantity |
NUMBER(10) |
N |
营销单品数量 |
price |
NUMBER(15,4) |
N |
营销单品价格 |
type |
String(32) |
N |
记录类型 |
discountAmount |
NUMBER(15,4) |
Y |
抵扣金额 |
goodsDetailJson |
String(3000) |
N |
营销信息(参考 响应定义) |
4.3.3 银联 CupQrCouponDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
spnsrId |
double |
Y |
出资方,1:银联出资,2:付款方(比如银行)出资,3:商户出资offstAmt |
offstAmt |
double |
Y |
出资金额 ,单位为元 |
4.3.4 银联 CouponInfo
参数 |
类型(字节长度) |
必填 |
参数说明 |
amount |
Double |
Y |
清算金额 ,单位为元 |
origAmount |
Double |
Y |
订单金额, 单位为元,商户提交的订单金额 |
cupQrCouponDetail |
List |
N |
优惠信息-二维码,成功的二维码类交易交易必填,活动维度的优惠展示 |
issAddnData |
IssAddnData |
N |
付款方附加数据,交易成功返回,商品维度的优惠展示 |
cupAcpCouponInfo |
CupAcpCouponInfo |
N |
优惠信息全渠道,成功的全渠道类交易(如:Wap,手机控件 等)必填,活动维度的优惠展示 |
4.3.4.1 CupQrCouponDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
spnsrId |
double |
Y |
出资方,1:银联出资,2:付款方(比如银行)出资,3:商户出资offstAmt |
offstAmt |
double |
Y |
出资金额 ,单位为元 |
4.3.4.2 IssAddnData
参数 |
类型(字节长度) |
必填 |
参数说明 |
样例 |
dctDetail |
List |
N |
商品优惠信息 |
交易成功,且请求参数中的收款方附加信息域中的单品命中优惠。商品维度展示优惠信息。 |
4.3.4.2.1 DctDetail说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
id |
String |
Y |
参与优惠的商品编号 |
dctId |
String |
Y |
优惠活动的编号 |
dctQuantity |
int |
Y |
商品优惠数量,本商品数量为 10,其中 2 件参示例:本商品数量为 10,其中 2 件参 |
dctPrice |
double |
Y |
商品优惠金额,单位:元。示例:商品单价10元,共 5件,其中2件参与优惠,每件优惠 3元,则本字段值为 6.00 |
addnInfo |
String |
N |
附加信息,内容自定义 |
4.3.4.3 CupAcpCouponInfo说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
discountAmt |
double |
Y |
总的优惠金额,单位:元,注:退货的时候返回,表示总的优惠回退金额 |
mchtDiscountAmt |
double |
N |
商户出资金额,单位:元,注:退货的时候返回,表示商户出资的回退金额 |
activityId |
String |
N |
活动编号,票券编号、活动编号等,格式自定义 |
activityNm |
String |
N |
活动简称,优惠活动简称,可用于展示、打单等 |
addnPrintInfo |
String |
N |
活动打印信息,内容自定义 |
4.4 交易失败异步通知
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
SS必填 |
参数说明 |
sign_type |
String |
YSS |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 默认 failpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户系统生成的订单号 示例值:6843192280647118 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 100 |
trade_no |
String(20) |
N |
银盛交易流水号。 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED等具体详情看下文中的交易状态详解 |
result_note |
String |
N |
交易结果描述,当交易失败时,保存错误描述 |
5. 银联行业码
5.1 请求参数说明
5.1.1 公共请求参数
参数 |
类型(长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.cupmulapp.qrcodepay.light |
partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
notify_url |
String(500) |
Y |
交易成功异步通知到商户的后台地址,http路径支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3,支持TLS1.0、TLS1.1、TLS1.2 |
version |
String(3) |
Y |
版本号3.0/3.1/3.2 /3.4 当前版本3.4 |
tran_type |
String(1) |
N |
交易类型,说明:1或者空:非担保交易,2:担保交易(D0不支持),无特殊需求 不用填此字段 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
5.1.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(1,32) |
Y |
商户系统内部订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
shopdate |
String(8,8) |
Y |
商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内 示例值:20180525 |
subject |
String(1,250) |
Y |
订单备注 |
total_amount |
Number(10,2) |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。Number(10,2)指10位长度,2位精度 示例值:100 |
seller_id |
String(1,20) |
|
收款商户号(银盛支付生成并下发) |
seller_name |
String(1,50) |
Y |
收款商户号对应商户名称 |
timeout_express |
String(2,6) |
Y |
设置未付款交易的超时时间,一旦超时,该笔交易就会自动被关闭,取值范围:1m~15d。m-分钟,h-小时,d-天。该参数数值不接受小数点,如1.5h,可转换为90m。注意:设置了未付款交易超时时间的情况下,若我司在限定时间内没有收到成功支付通知,则会关闭交易,关闭后该笔交易若付款方支付成功的情况下,会自动原路退款至付款方。示例值:96h 代表96小时后订单自动关闭 |
business_code |
String(1,10) |
Y |
业务代码 ,请联系银盛客户经理获取 |
spbill_create_ip |
String(16) |
Y |
必须传正确的用户端ip 示例值:123.12.12.123 |
bank_type |
String(7\ |
9) |
Y |
行别,银联扫码-9001002 |
userId |
String(128) |
Y |
银联用户标识(用户在APP上的标识号,用来提供给收款方,并在收款方发起交易时回传给付款) |
allow_repeat_pay |
String(2) |
Y |
是否允许多次支付,Y:允许;N:不允许(参数为空或者Y时,默认该笔订单交易状态非成功状态时,支持选择其他支付方式继续付款, 当为N时表示该笔订单交易状态为失败状态时,不支持选择其他支付方式继续付款) |
extra_common_param |
String(2000) |
N |
公用回传参数 商户自定义数据域,原样返回 |
currency |
String(3) |
N |
默认CNY(人民币) |
extend_params |
String(500) |
N |
业务扩展参数,一个json字符串,order_mode订单模式,暂时可选的值为:00 代表购物车模式;seller_list参与分账的收款方信息数组,每个元素包含seller_id收款方银盛支付用户号。实时分账业务,order_mode和seller_list均不能为空,order_mode的值必须为00。示例值:样例8.8 |
sub_merchant |
SubMerchantInfo |
N |
二级商户信息, Json格式 参考样例,暂包括merName、merShortName、merAddr、telephone、merNo、category、mrchntCertId ,如果有值则二级商户信息都不能为空,如果没值则都不能有值 示例值:样例9.2 |
consignee_info |
ConsigeeInfo |
N |
收货人信息json格式 示例值:样例9.3 |
device_info |
String(8) |
N |
终端号 自定义 8位整数 |
terminal_info |
String(300) |
N |
终端信息 |
limit_credit_pay |
String(2) |
N |
是否限制信用卡。值为1表示禁用信用卡,0或为空表示不限制 |
fail_notify_url |
String(190) |
N |
失败通知地址(交易状态为失败时,银盛支付服务器主动通知商户网站里指定的页面http路径,支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3)注:只有不允许重复支付的交易才会通知 |
submer_ip |
String(16) |
N |
子商户ip 112.112.112.112 |
paygate_no |
String(1,32) |
N |
扫码交易路由,如下:(900000001)银联-支付宝 (9000010)银联-微信(10810001)银联扫码-银联云闪付(10010001)网联-微信(10000012)网联-支付宝 |
payee_fee |
Number(10,2) |
N |
收款方费用 |
src_fee |
Number(10,2) |
N |
发起方费用 |
src_fee_flag |
String(1,8) |
N |
发起方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
payee_fee_flag |
String(1,8) |
N |
收款方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
5.2 响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.2.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_cupmulapp_qrcodepay_light_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2.2 业务响应参数
5.3 页面跳转参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过系统程序控制客户端页面自动跳转的方式通知给商户网站。这些处理结果数据就是页面跳转同步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型 默认 RSA |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 directpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户系统内部订单号 |
trade_no |
String(20) |
N |
银盛支付交易流水号 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS 示例值:样例11.1 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:100 |
account_date |
String(19) |
N |
入账日期,格式"yyyyMMdd" 示例值:20140724 |
extra_common_param |
String(2000) |
N |
公用回传参数 商户自定义数据域,原样返回 |
5.4 交易成功异步通知
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过系统程序控制客户端页面自动跳转的方式通知给商户网站。这些处理结果数据就是页面跳转同步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 directpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户系统内部订单号 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED 示例值:样例11.1 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示值值:100 |
trade_no |
String(20) |
N |
银盛支付交易流水号 |
account_date |
String(10) |
N |
入账的时间,格式"yyyyMMdd" 示例值:20140724 |
payer_fee |
Number |
N |
该笔订单的付款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:1.00 |
payee_fee |
Number |
N |
该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:1.00 |
partner_fee |
Number |
N |
该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:1.00 |
fee |
Number |
N |
该笔订单的手续费总和(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:1.00 |
channel_send_sn |
String(50) |
N |
发往渠道流水号 |
paygate_no |
String(16) |
N |
支付网关编号 |
channel_recv_sn |
String(50) |
N |
渠道返回流水号 |
card_type |
String |
N |
卡类型credit:信用卡debit:借记卡 |
payer_bank_account_no |
String |
N |
银联云闪付款方账号 |
extra_common_param |
String(2000) |
N |
商户自定义数据域,原样返回 |
coupon_info |
String |
N |
JSON字符串,银联营销渠道响应优惠信,version小于3.6版本为List的JSON字符串,3.6版本(含)以上为CouponInfo的JSON字符串 |
preferential_amount |
Number |
N |
营销优惠金额 版本3.9及以支持 示例值:样例1.2 |
preferential_fee |
Number |
N |
营销优惠手续费 版本3.9及以支持 示例值:样例0.02 |
marketing_rule_json |
String |
N |
营销规则信息json 版本3.9及以支持 |
5.5 交易失败异步通知
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 failpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户系统内部订单号 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:100 |
trade_no |
String(20) |
N |
该交易在银盛支付系统中的交易流水号。 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED等 示例值:样例11.1 |
result_note |
String |
N |
交易结果描述,当交易失败时,保存错误描述 |
6. 微信公众号&小程序
6.1 请求参数说明
6.1.1 公共请求参数
参数 |
类型(长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.weixin.pay.light |
partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
notify_url |
String(500) |
Y |
交易成功异步通知到商户的后台地址,http路径支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3,支持TLS1.0、TLS1.1、TLS1.2 |
version |
String(3) |
Y |
版本号3.0/3.1/3.2 /3.4 当前版本3.4 |
tran_type |
String(1) |
N |
交易类型,说明:1或者空:非担保交易,2:担保交易(D0不支持),无特殊需求 不用填此字段 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
6.1.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 201805256843192280647118 |
shopdate |
String(8,8) |
N |
商户系统的交易发生日期格式yyyyMMdd 20180525 |
subject |
String(1,250) |
Y |
订单备注 |
total_amount |
Number(10,2) |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。Number(10,2)指10位长度,2位精度。100 |
currency |
String(3) |
N |
默认CNY(人民币) |
seller_id |
String(1,20) |
Y |
收款商户号 |
seller_name |
String(1,50) |
Y |
收款商户号对应商户名称 |
timeout_express |
String(2,6) |
Y |
设置未付款交易的超时时间,一旦超时,该笔交易就会自动被关闭,取值范围:1m~15d。m-分钟,h-小时,d-天。该参数数值不接受小数点,如1.5h,可转换为90m。注意:设置了未付款交易超时时间的情况下,若我司在限定时间内没有收到成功支付通知,则会关闭交易,关闭后该笔交易若付款方支付成功的情况下,会自动原路退款至付款方。 96h |
extend_params |
String(500) |
N |
业务扩展参数,一个json字符串,order_mode订单模式,暂时可选的值为:00 代表购物车模式;seller_list参与分账的收款方信息数组,每个元素包含seller_id收款方银盛支付用户号。实时分账业务,order_mode和seller_list均不能为空,order_mode的值必须为00。示例值:样例8.8 |
extra_common_param |
String(2000) |
N |
公用回传参数 商户自定义数据域,原样返回 |
business_code |
String(1,10) |
Y |
业务代码 ,请联系银盛客户经理获取 |
sub_openid |
String(128) |
Y |
用户在商户appid下的唯一标识。可参考https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-3获取 |
is_minipg |
String(1) |
N |
【微信小程序支付:1】,【 微信公众号支付:2或不传】 |
appid |
String(32) |
Y |
商户在微信侧申请的小程序或公众号APPID。当发起公众号支付时,需填写公众号的APPID(应用ID);当发起小程序支付时,需填写小程序的APPID(应用ID) |
sub_merchant |
SubMerchantInfo |
N |
二级商户信息, Json格式,暂包括merName、merShortName、merAddr、mobileNo、merNo、category、mrchntCertId,如果有值则二级商户信息都不能为空,如果没值则都不能有值 |
consignee_info |
ConsigeeInfo |
N |
收货人信息json格式 |
limit_credit_pay |
String(2) |
N |
是否限制信用卡支付。值为1表示禁用信用卡支付,0或为空表示不限制 |
allow_repeat_pay |
String(2) |
N |
是否允许多次支付,Y:允许;N:不允许(参数为空或者Y时,默认该笔订单交易状态非成功状态时,支持选择其他支付方式继续付款, 当为N时表示该笔订单交易状态为失败状态时,不支持选择其他支付方式继续付款) |
fail_notify_url |
String(190) |
N |
失败通知地址(交易状态为失败时,银盛通知商户网站里指定的页面http路径,支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3)注:只有不允许重复支付的交易才会通知 |
detail |
String(6000) |
N |
微信商品详情,单品优惠活动 参考 detail附录 |
submer_ip |
String(16) |
N |
请求方ip 112.112.112.112 |
paygate_no |
String(1,32) |
N |
扫码交易路由,(900000001)银联-支付宝 , (9000010)银联-微信 , (10810001) 银联-云闪付 , (10010001)网联-微信 , (10000012)网联-支付宝 |
payee_fee |
Number(10,2) |
N |
收款方费用 |
src_fee |
Number(10,2) |
N |
发起方费用 |
src_fee_flag |
String(1,8) |
N |
发起方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
payee_fee_flag |
String(1,8) |
N |
收款方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
union_qrcode_259_params |
UnionQrCodeBaseRequest |
N |
银联259号文条码改造字段,json格式 |
6.1.3 二级商户 SubMerchantInfo
参数 |
类型(字节长度) |
必填 |
参数说明 |
merName |
String(50) |
N |
二级商户名称,支持25个中文 |
merShortName |
String(50) |
N |
二级商户简称,支持25个中文 |
merAddr |
String(200) |
N |
二级商户地址,支持100个中文 |
telephone |
String(13) |
N |
固定电话/手机号码二选一 |
merNo |
String(32) |
N |
二级商户编号 |
category |
String(20) |
N |
类目,按附件内容输入类目编号 |
mrchntCertId |
String(15\ |
18) |
N |
身份证号,只支持身份证格式(DES加密,密钥为商户号前8位,不足8位在商户号前补空格) |
6.1.4 收货人信息 ConsigeeInfo
参数 |
类型(字节长度) |
必填 |
参数说明 |
consigneeName |
String(150) |
N |
收货人姓名 |
consigneeAddr |
String(200) |
N |
收货地址 |
transportationInfo |
String(200) |
N |
物流配送信息(物流名称+订单号) |
commodityName |
String(150) |
N |
商品名称 |
commodityNumber |
String(10) |
N |
商品数量, |
6.1.5 detail 微信单品优惠
参数 |
类型(字节长度) |
必填 |
参数说明 |
cost_price |
double |
N |
订单原价,整数不超过14位,小数不 超过2位,单位元 10.50 |
receipt_id |
String(32) |
N |
商品小票ID,长度不能超过32位 Ys001001 |
goods_detail |
List |
Y |
商品列表 |
6.1.6 银联259号文条码改造字段 UnionQrCodeBaseRequest
参数 |
类型(字节长度) |
必填 |
参数说明 |
terminal_no |
String(8) |
N |
终端号 |
terminal_type |
String(2) |
N |
终端类型(线下交易场景必填) |
serial_num |
String(50) |
N |
终端序列号 |
network_license |
String(5) |
N |
银行卡受理终端产品入网认证编号 |
app_version |
String(5) |
N |
终端应用程序的版本号 |
terminal_gps |
String(32) |
N |
交易设备位置信息 |
terminal_ip |
String(8) |
N |
交易设备的IP |
encryp_rand_num |
String(10) |
N |
加密随机因子 |
secret_text |
String(16) |
N |
密文数据 |
6.1.5.1 goods 微信商品列表
参数 |
类型(字节长度) |
必填 |
参数说明 |
goods_id |
String(32) |
Y |
商户商品编码,由半角的大小写字母,数字,下划线,中划线中的一种或者几种组成,长度不能超过32位 Shouji_abcef_001-001 |
wxpay_goods_id |
String(32) |
N |
微信支付定义的统一商品编号,长度不能超过32 ,1001 |
goods_name |
String(256) |
N |
商品的实际名称,长度不能超过256 |
quantity |
int(10) |
Y |
数量,只能是正整数 ,1000 |
price |
Double |
Y |
商品单价,单位元,整数部分不能超过12位,小数不能超过2位 , 100.20 |
6.2 响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
6.2.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_weixin_pay_light_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
6.2.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(32) |
Y |
商户系统生成的订单号 6843192280647118 |
trade_no |
String(20) |
N |
银盛支付交易流水号 |
trade_status |
String |
Y |
交易状态,成功状态的值: TRADE_SUCCESS参考附录8.1 |
total_amount |
Number |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。100 |
currency |
String(3) |
N |
交易币种 默认CNY |
extra_common_param |
String(2000) |
N |
公用回传参数 商户自定义数据域,原样返回 |
jsapi_pay_info |
String |
Y |
Json格式字符串,作用于原生态的js支付时的参数 |
is_discount |
String |
N |
是否参与优惠,Y表示参数,N表示不参与 Y\ |
N |
total_discount |
double |
N |
参考总优惠金额 100.00 |
channel_send_sn |
String(50) |
N |
发往渠道流水号 |
6.2.3 jsapi_pay_info 支付串
参数 |
类型(长度) |
必填 |
参数说明 |
appId |
string[1,32] |
Y |
商户在微信侧申请的APPID,接口返回jsapi_pay_info中的信息 wxd678efh567hg6787 |
timeStamp |
string[1,32] |
Y |
时间戳,接口返回jsapi_pay_info中的信息 |
nonceStr |
string[1,32] |
Y |
随机字机串,接口返回jsapi_pay_info中的信息 5K8264ILTKCH16CQ2502SI8 |
package |
string[1,128] |
Y |
订单详情扩展字符串,接口返回jsapi_pay_info中的信息 prepay_id=u802345jgfjsdfg |
signType |
string[1,32] |
Y |
签名方式,接口返回 jsapi_pay_info中的信息 MD5 |
paySign |
string[1,256] |
Y |
签名,接口返回jsapi_pay_info中的信息 C380BEC2BFD727A4B6845132 |
6.3 异步通知参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型默认 directpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户生成的订单号 6843192280647118 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 100 |
trade_no |
String(20) |
N |
银盛支付交易流水号 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED等具体详情看下文中的交易状态详解 |
account_date |
String(10) |
N |
入账的时间,格式"yyyyMMdd" 20140724 |
payer_fee |
Number |
N |
该笔订单的付款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 1.00 |
payee_fee |
Number |
N |
该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。1.00 |
partner_fee |
Number |
N |
该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。1.00 |
fee |
Number |
N |
该笔订单的手续费总和(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。1.00 |
channel_send_sn |
String(50) |
N |
发往渠道流水号 12345678a |
paygate_no |
String(16) |
N |
支付网关编号 (9000010)银联-微信 (10010001)网联-微信 |
channel_recv_sn |
String(50) |
N |
渠道返回流水号 12345678a |
card_type |
String |
N |
卡类型credit:信用卡debit:借记卡 |
extra_common_param |
String(2000) |
N |
公用回传参数 商户自定义数据域,原样返回 |
is_discount |
String |
N |
是否参与优惠,Y表示参数,N表示不参与 |
total_discount |
double |
N |
参考汇总优惠金额 100.00 |
wxpay_coupon_info |
String |
N |
微信优惠活动优惠明细 Json 参考 附录及定义 |
wxpay_coupon_good_detail |
List |
N |
微信优惠活动单品信息 Json 参考 附录及定义 |
preferential_amount |
Number |
N |
营销优惠金额 版本3.9及以支持 示例值:样例1.2 |
preferential_fee |
Number |
N |
营销优惠手续费 版本3.9及以支持 示例值:样例0.02 |
marketing_rule_json |
String |
N |
营销规则信息json 版本3.9及以支持 |
6.3.1 wxpay_coupon_info
参数 |
类型(字节长度) |
必填 |
参数说明 |
fee_type |
String(16) |
N |
标价币种,默认人民币CNY |
total_fee |
double |
Y |
标价金额,订单总金额,单位为元 12.00 |
cash_fee_type |
String(16) |
N |
现金支付币种,默认CNY |
cash_fee |
double |
Y |
现金支付金额 :订单现金支付金额(即客户实际付款金额),单位元 1.01 |
settlement_total_fee |
double |
N |
应结订单金额:当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。单位元 |
coupon_fee |
double |
N |
代金券金额:代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额,单位元 |
ext |
String |
N |
附录字段 |
promotionDetail |
String |
Y |
单品优惠活动,详细信息如下 json |
参数 |
类型(字节长度) |
必填 |
参数说明 |
promotion_id |
String(32) |
Y |
券 ID券或者立减优惠ID 109519 |
name |
String(64) |
N |
优惠名称 单品惠-6 |
scope |
String(32) |
N |
优惠范围 GLOBAL- 全场代金券;SINGLE- 单品优惠 |
type |
String(32) |
N |
优惠类型COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致)DISCOUNT- 优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致 |
amount |
double |
Y |
用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 ),单位:元 5.00 |
activity_id |
String(32) |
N |
活动 ID,在微信商户后台配置的批次 ID 931386 |
wxpay_contribute |
String(32) |
N |
微信出资 特指由微信支付商户平台创建的优惠,出资金额 等于本项优惠总金额,单位为元 0.00 |
merchant_contribute |
String(32) |
N |
商户出资 特指商户自己创建的优惠,出资金额等于本项优惠总金额,单位为元 0.00 |
other_contribute |
String(32) |
N |
其他出资 其他出资方出资金额,单位为元 5.00 |
6.3.2 wxpay_coupon_good_detail
参数 |
类型(长度) |
必填 |
参数说明 |
goods_id |
String(32) |
Y |
商户商品编码 由半角的大小写字母、数字、中划线、下划线中的种或几种组成 109519 |
goods_remark |
String(128) |
N |
商品备注 goods_remark 为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。1001 |
discount_amount |
double |
Y |
商品优惠金额 单品的总优惠金额,单位为元 1.00 |
quantity |
Int |
Y |
商品数量 用户购买的数量 11 |
price |
double |
Y |
商品价格 单位为:元。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔 100 元的订单使用了商场发的纸质优惠券 100-50,则活动商品的单价应为原单价-50) 5285.00 |
promotionId |
String(32) |
Y |
券或者立减优惠id 关联 promotionDetail.promotion_id |
7. 支付宝生活号
7.1 请求参数说明
7.1.1 公共请求参数
参数 |
类型(长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.alijsapi.pay.light |
partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
notify_url |
String(500) |
Y |
交易成功异步通知到商户的后台地址,http路径支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3,支持TLS1.0、TLS1.1、TLS1.2 |
version |
String(3) |
Y |
版本号3.0/3.1/3.2 /3.4 当前版本3.4 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
7.1.2 业务请求参数
业务参数(参数名biz_content,值为一个json格式对象,下面列表描述json对象的值):
参数 |
类型(长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 201805256843192280647118 |
shopdate |
String(8,8) |
N |
商户系统的交易发生日期格式yyyyMMdd 20180525 |
subject |
String(1,250) |
Y |
订单备注 |
total_amount |
Number(10,2) |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。Number(10,2)指10位长度,2位精度 ,100 |
currency |
String(3) |
N |
默认CNY(人民币) |
seller_id |
String(1,20) |
Y |
收款商户号 |
seller_name |
String(1,50) |
Y |
收款商户号对应商户名称 |
timeout_express |
String(2,6) |
Y |
设置未付款交易的超时时间,一旦超时,该笔交易就会自动被关闭,取值范围:1m~15d。m-分钟,h-小时,d-天。该参数数值不接受小数点,如1.5h,可转换为90m。注意:设置了未付款交易超时时间的情况下,若我司在限定时间内没有收到成功支付通知,则会关闭交易,关闭后该笔交易若付款方支付成功的情况下,会自动原路退款至付款方。96h |
extend_params |
String(500) |
N |
业务扩展参数,一个json字符串,order_mode订单模式,暂时可选的值为:00 代表购物车模式;seller_list参与分账的收款方信息数组,每个元素包含seller_id收款方银盛支付用户号。实时分账业务,order_mode和seller_list均不能为空,order_mode的值必须为00。示例值:样例8.8 |
extra_common_param |
String(2000) |
N |
公用回传参数 |
business_code |
String(1,10) |
Y |
业务代码 ,请联系银盛客户经理获取 |
buyer_logon_id |
String(100) |
N |
买家支付宝账号,和buger_id不能同时为空 |
buyer_id |
String(100) |
N |
买家支付宝用户ID,和buyer_logon_id不能同时为空。buyer_id获取方法:https://doc.open.alipay.com/doc2/detail.htm?spm=a219a.7629140.0.0.8ujLD6&treeId=115&articleId=104114&docType=1通过网页授权获取用户信息,同步响应结果中的user_id对应文档中的buyer_id。 |
sub_merchant |
SubMerchantInfo |
N |
二级商户信息, Json格式,暂包括merName、merShortName、merAddr、mobileNo、merNo、category、mrchntCertId 如果有值则二级商户信息都不能为空,如果没值则都不能有值 示例值:样例9.2 |
consignee_info |
ConsigeeInfo |
N |
收货人信息json格式 示例值:样例9.3 |
limit_credit_pay |
String(2) |
N |
是否限制信用卡。值为1表示禁用信用卡,0或为空表示不限制 |
hb_fq_num |
String(2) |
N |
花呗分期期数,仅在支付宝支付的时候生效,目前期数支持3,6,12 |
fq_type |
String(2) |
N |
分期类型,值为00表示花呗分期,值01表示信用卡分期。不填默认为花呗分期 |
allow_repeat_pay |
String(2) |
N |
是否允许多次支付,Y:允许;N:不允许(参数为空或者Y时,默认该笔订单交易状态非成功状态时,支持选择其他支付方式继续付款, 当为N时表示该笔订单交易状态为失败状态时,不支持选择其他支付方式继续付款) |
fail_notify_url |
String(190) |
N |
失败通知地址(交易状态为失败时,银盛支付服务器主动通知商户网站里指定的页面http路径,支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3)注:只有不允许重复支付的交易才会通知 |
aliGoodsDetails |
List |
N |
支付宝营销单品详情列表 |
submer_ip |
String(16) |
N |
子商户ip 112.112.112.112 |
paygate_no |
String(1,32) |
N |
扫码交易路由,如下:(900000001)银联-支付宝 (9000010)银联-微信(10810001)银联扫码-银联云闪付(10010001)网联-微信(10000012)网联-支付宝 |
payee_fee |
Number(10,2) |
N |
收款方费用 |
src_fee |
Number(10,2) |
N |
发起方费用 |
src_fee_flag |
String(1,8) |
N |
发起方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
payee_fee_flag |
String(1,8) |
N |
收款方手续费收取方式,01:实时结算未统计,03:月结算,未统计 |
store_id |
String(32) |
N |
商户门店编号 |
alipay_store_id |
String(32) |
N |
支付宝的店铺编号 |
operator_id |
String(28) |
N |
商户操作员编号 |
terminal_id |
String(32) |
N |
商户机具终端编号 |
union_qrcode_259_params |
UnionQrCodeBaseRequest |
N |
银联259号文条码改造字段,json格式 |
extend_params_channel |
String |
N |
支付宝业务拓展参数json格式 示例值:{"food_order_type":"qr_order"} |
7.1.3 二级商户 SubMerchantInfo
参数 |
类型(长度) |
必填 |
参数说明 |
merName |
String(50) |
N |
二级商户名称,支持25个中文 |
merShortName |
String(50) |
N |
二级商户简称,支持25个中文 |
merAddr |
String(200) |
N |
二级商户地址,支持100个中文 |
telephone |
String(13) |
N |
固定电话/手机号码二选一 |
merNo |
String(32) |
N |
二级商户编号 |
category |
String(20) |
N |
类目,按附件内容输入类目编号 |
mrchntCertId |
String(15\ |
18) |
N |
身份证号,只支持身份证格式(如果签名方式为RSA,则用DES加密,密钥为商户号前8位,不足8位在商户号前补空格;如果签名方式为SM,则用SM加密) |
7.1.4 收货人信息 ConsigeeInfo
参数 |
类型(长度) |
必填 |
参数说明 |
consigneeName |
String(150) |
N |
收货人姓名 |
consigneeAddr |
String(200) |
N |
收货地址 |
transportationInfo |
String(200) |
N |
物流配送信息(物流名称+订单号) |
commodityName |
String(150) |
N |
商品名称 |
commodityNumber |
String(10) |
N |
商品数量, |
7.1.5 支付宝营销 AliGoodsDetail
参数 |
类型(长度) |
必填 |
参数说明 |
goods_id |
String(32) |
Y |
商品编号 |
alipay_goods_id |
String(32) |
N |
支付宝定义的统一商品编号 |
goods_name |
String(256) |
Y |
营销单品名称 |
quantity |
String(10) |
Y |
营销单品数量 不超过10位的正整数 |
price |
String(12) |
Y |
营销单品单价 [0,999999999] 左闭右闭区间,小数点后最多允许两位 |
goods_category |
String(24) |
N |
营销单品类目 |
categories_tree |
String(128) |
N |
营销单品类目树 |
body |
String(1000) |
N |
营销单品描述 |
show_url |
String(400) |
N |
营销单品展示地址 |
7.1.6 银联259号文条码改造字段 UnionQrCodeBaseRequest
参数 |
类型(字节长度) |
必填 |
参数说明 |
terminal_no |
String(8) |
N |
终端号 |
terminal_type |
String(2) |
N |
终端类型(线下交易场景必填) |
serial_num |
String(50) |
N |
终端序列号 |
network_license |
String(5) |
N |
银行卡受理终端产品入网认证编号 |
app_version |
String(5) |
N |
终端应用程序的版本号 |
terminal_gps |
String(32) |
N |
交易设备位置信息 |
terminal_ip |
String(8) |
N |
交易设备的IP |
encryp_rand_num |
String(10) |
N |
加密随机因子 |
secret_text |
String(16) |
N |
密文数据 |
7.2 响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
7.2.1 公共响应参数
参数 |
类型(长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_alijsapi_pay_light_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
7.2.2 业务响应参数
参数 |
类型(长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(32) |
Y |
商户唯一订单号 2018012500001 |
trade_no |
String(20) |
N |
银盛支付交易流水号 |
trade_status |
String |
Y |
交易状态,成功的值: TRADE_SUCCESS 示例值:附录10.1 |
total_amount |
Number |
Y |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。100 |
currency |
String(3) |
N |
交易币种 默认CNY |
extra_common_param |
String |
N |
商户自定义数据域,原样返回 |
jsapi_pay_info |
String |
Y |
Json格式字符串,作用于原生态的js支付时的参数 |
channel_send_sn |
String(50) |
N |
发往渠道流水号 |
channel_recv_sn |
String(50) |
N |
渠道返回流水号 |
7.3 交易成功异步通知
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型默认 directpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
out_trade_no |
String(32) |
Y |
商户生成的订单号 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
trade_no |
String(20) |
N |
银盛支付交易流水号 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED 示例值:附录10.1 |
account_date |
String(10) |
N |
入账的时间,格式"yyyyMMdd" |
payer_fee |
Number |
N |
该笔订单的付款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
payee_fee |
Number |
N |
该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
partner_fee |
Number |
N |
该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
fee |
Number |
N |
该笔订单的手续费总和(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
channel_send_sn |
String(50) |
N |
发往渠道流水号 |
paygate_no |
String(16) |
N |
支付网关编号 |
channel_recv_sn |
String(50) |
N |
渠道返回流水号 |
card_type |
String |
N |
卡类型credit:信用卡debit:借记卡 |
buyer_user_id |
String |
N |
支付宝用户Uid |
buyer_logon_id |
String |
N |
支付宝账户 |
extra_common_param |
String |
N |
公用回传参数 商户自定义数据域,原样返回 |
alipay_trx_resp_coupon_info |
String |
N |
支付宝优惠信息,版本号3.5及以上支持 |
ali_merchant_amount |
String |
N |
支付宝商家优惠金额,版本号3.5及以上支持 |
ali_platform_dis_amount |
String |
N |
支付宝平台优惠金额,版本号3.5及以上支持 |
ali_goods_details |
String |
N |
ListJSON字符串 支付宝营销单品信息,版本3.5及以上支持 |
preferential_amount |
Number |
N |
营销优惠金额 版本3.9及以支持 示例值:样例1.2 |
preferential_fee |
Number |
N |
营销优惠手续费 版本3.9及以支持 示例值:样例0.02 |
marketing_rule_json |
String |
N |
营销规则信息json 版本3.9及以支持 |
7.3.1 支付宝营销 GoodsDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
id |
String(64) |
Y |
记录编号,唯一标识 |
tradesn |
String(30) |
Y |
银盛交易流水 |
seq |
Integer(4) |
Y |
银盛交易流水序列号 |
createtime |
Date |
Y |
记录创建时间 |
wxpayGoodsId |
String(32) |
N |
渠道单品标识 |
goodsName |
String(256) |
N |
营销单品名称 |
goodsId |
String(32) |
Y |
营销单品标识 |
goodsRemark |
String(256) |
N |
营销单品备注 |
quantity |
NUMBER(10) |
N |
营销单品数量 |
price |
NUMBER(15,4) |
N |
营销单品价格 |
type |
String(32) |
N |
记录类型 “WXREQ”:微信单品营销请求;“WXRESP”:微信单品营销渠道响应;“ALIREQ”:支付宝单品营销请求;“ALIRESP”:支付宝单品营销渠道响应 |
discountAmount |
NUMBER(15,4) |
Y |
抵扣金额 |
goodsDetailJson |
String(3000) |
N |
type为WXREQ/ALIREQ请求类型时,为原始传入的单品营销参数JSON字符串。type为WXRESP/ALIRESP时为渠道返回的单品营销响应原始信息JSON字符串 |
7.4 交易失败异步通知
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
签名类型,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 默认 failpay.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户唯一订单号 6843192280647118 |
total_amount |
Number |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
trade_no |
String(20) |
N |
银盛交易流水号。 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ |
TRADE_CLOSED 示例值:附录10.1 |
result_note |
String |
N |
交易结果描述,当交易失败时,保存错误描述 |
8. 样例
8.1 detail 字段值
{
"cost_price":608800,
"receipt_id":"wx123",
"goods_detail":[
{
"goods_id":"商品编码",
"wxpay_goods_id":"1001",
"goods_name":"",
"quantity":1,
"price":528800
},
{
"goods_id":"商品编码",
"wxpay_goods_id":"1002",
"goods_name":"iPhone6s 32G",
"quantity":1,
"price":608800
}
]
}
8.2 wxpay_coupon_info
{
"cash_fee": 22.09,
"cash_fee_type": "CNY",
"coupon_fee": 4,
"fee_type": "CNY",
"promotionDetails": [{
"activity_id": "72560",
"amount": 4,
"merchant_contribute": 0,
"name": "21--30 单品免充 4",
"other_contribute": 4,
"promotion_id": "0219457",
"scope": "SINGLE",
"type": "DISCOUNT",
"wxpay_contribute": 0
}],
"settlement_total_fee": 22.09,
"total_fee": 26.09
}
8.3 wxpay_coupon_good_detail
{
"discount_amount": 4,
"goods_id": "11111",
"goods_remark": "商品名称",
"price": 26.1,
"quantity": 1
}
8.4 AliGoodsDetail 营销信息
[
{
"goods_id":"apple-01",
"alipay_goods_id":"20010001",
"goods_name":"ipad",
"quantity":1,
"price":2000,
"goods_category":"34543238",
"categories_tree":"124868003| 126232002| 126252004",
"body":"特价手机",
"show_url":"http://www.alipay.com/xxx.jpg"
}
]
8.5 coupon_info 信息
[{
"spnsrId": "1",
"offstAmt": 1
}, {
"spnsrId": "2",
"offstAmt": 2
}]
8.6 sub_merchant 说明
{
"merName": "二级商户名称",
"merShortName": "二级商户简称",
"merAddr": "二级商户地址",
"telephone": "二级商户服务电话",
"merNo": "二级商户编号",
"category": "类目",
"mrchntCertId": "身份证号"
}
8.7 收信人信息 consignee_info
{
"consigneeName": "收货人姓名",
"consigneeAddr": "收货地址",
"transportationInfo": "物流配送信息",
"commodityName": "商品名称",
"commodityNumber": "商品数量"
}
8.8 业务扩展 extend_params
{
"cartTYpe": "00",
"order_mode": "01",
"seller_list": [{
"seller_id": "123"
}, {
"seller_id": "456"
}]
}
9、附录
9.1 交易状态
枚举名称 |
枚举说明 |
WAIT_BUYER_PAY |
交易创建,等待买家付款。 |
TRADE_CLOSED |
在指定时间段内未支付时关闭的交易;客户主动关闭订单。 |
TRADE_SUCCESS |
交易成功,且可对该交易做操作,如:多级分润、退款等。 |
TRADE_PART_REFUND |
部分退款成功。 |
TRADE_ALL_REFUND |
全部退款成功。 |
WAIT_SELLER_SEND_GOODS |
买家已付款,等待卖家发货 |
WAIT_BUYER_CONFIRM_GOODS |
卖家已发货,等待买家确认 |
9.2 参考错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
系统错误 |
请调用查询接口查询订单状态 |
ACQ.CONNECT_PAYGATE_TIME_OUT |
业务超时 |
请调用查询接口查询订单状态 |
ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
9.3 支付网关编号
支付渠道代码 |
支付渠道 |
900000001 |
银联-支付宝 |
9000010 |
银联-微信 |
10810001 |
银联扫码-银联云闪付 |
10010001 |
网联-微信 |
10000012 |
网联-支付宝 |