参数附录

支付渠道及说明

参数

名称

expend 参数

alipay

支付宝 App 支付

alipay参数

alipay_qr

支付宝正扫

alipay_qr参数

alipay_wap

支付宝 H5 支付

alipay_wap参数

alipay_lite

支付宝小程序支付

alipay_lite参数

alipay_pub

支付宝生活号支付

alipay_pub参数

alipay_scan

支付宝反扫

alipay_scan参数

wx_pub

微信公众号支付

wx_pub参数

wx_lite

微信小程序支付

wx_lite参数

wx_scan

微信反扫

wx_scan参数

union

银联云闪付 App(云闪付入驻)

union参数

union_qr

银联云闪付正扫(云闪付入驻)

union_qr参数

union_wap

银联云闪付 H5 支付(云闪付入驻)

union_wap参数

union_scan

银联云闪付反扫(云闪付入驻)

union_scan参数

union_online

银联 H5 支付

union_online参数

union_checkout

银联统一收银台支付

union_checkout参数

fast_pay

快捷支付

fast_pay参数

b2c

个人网银支付

b2c参数

b2b

企业网银支付

b2b参数

支付渠道 expend参数 说明

根据支付是渠道的不同,您需要本章节内容,在发起交易时上送特定渠道所需要的额外参数,以及根据部分渠道支付成功返回的额外参数进行响应的处理。

注:未支付订单,保留 pay_info ,可在订单有效期内再次支付,无需重复下单。

alipay参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

hb_fq_num

String(2)

N

支付金额大于等于 100 元时,可不指定分期数,用户可自由选择分期数;支付金额小于 100 元时,必须指定分期数,否则不支持花呗分期支付;指定分期数后用户不能更分期数;分期数目前只支持 3、6、12。花呗分期的手续费由用户自己承担。

mer_discount_flag

String(1)

N

商户传入分期期数时有效。传入: Y,商户贴息,默认用户贴息

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

sub_open_id

买家的支付宝用户 id

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

alipay_qr参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

hb_fq_num

String(2)

N

支付金额大于等于 100 元时,可不指定分期数,用户可自由选择分期数;支付金额小于 100 元时,必须指定分期数,否则不支持花呗分期支付;指定分期数后用户不能更分期数;分期数目前只支持 3、6、12。花呗分期的手续费由用户自己承担。

mer_discount_flag

String(1)

N

商户传入分期期数时有效。传入: Y,商户贴息,默认用户贴息

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

qrcode_url

二维码连接

sub_open_id

买家的支付宝用户 id

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

alipay_wap参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

hb_fq_num

String(2)

N

支付金额大于等于 100 元时,可不指定分期数,用户可自由选择分期数;支付金额小于 100 元时,必须指定分期数,否则不支持花呗分期支付;指定分期数后用户不能更分期数;分期数目前只支持 3、6、12。花呗分期的手续费由用户自己承担。

mer_discount_flag

String(1)

N

商户传入分期期数时有效。传入: Y,商户贴息,默认用户贴息

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

sub_open_id

买家的支付宝用户 id

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

alipay_lite参数

请求参数

参数

类型

必填

描述

buyer_id

String(100)

Y

买家的支付宝用户 id

buyer_logon_id

String(100)

N

买家支付宝账号

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

hb_fq_num

String(2)

N

支付金额大于等于 100 元时,可不指定分期数,用户可自由选择分期数;支付金额小于 100 元时,必须指定分期数,否则不支持花呗分期支付;指定分期数后用户不能更分期数;分期数目前只支持 3、6、12。花呗分期的手续费由用户自己承担。

mer_discount_flag

String(1)

N

商户传入分期期数时有效。传入: Y,商户贴息,默认用户贴息

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

sub_open_id

买家的支付宝用户 id

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

alipay_pub参数

请求参数

参数

类型

必填

描述

buyer_id

String(100)

Y

买家的支付宝用户 id

buyer_logon_id

String(100)

N

买家支付宝账号

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

hb_fq_num

String(2)

N

支付金额大于等于 100 元时,可不指定分期数,用户可自由选择分期数;支付金额小于 100 元时,必须指定分期数,否则不支持花呗分期支付;指定分期数后用户不能更分期数;分期数目前只支持 3、6、12。花呗分期的手续费由用户自己承担。

mer_discount_flag

String(1)

N

商户传入分期期数时有效。传入: Y,商户贴息,默认用户贴息

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

sub_open_id

买家的支付宝用户 id

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

alipay_scan参数

请求参数

参数

类型

必填

描述

auth_code

String(128)

Y

扫码设备读出的条形码或者二维码信息

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

hb_fq_num

String(2)

N

支付金额大于等于 100 元时,可不指定分期数,用户可自由选择分期数;支付金额小于 100 元时,必须指定分期数,否则不支持花呗分期支付;指定分期数后用户不能更分期数;分期数目前只支持 3、6、12。花呗分期的手续费由用户自己承担。

mer_discount_flag

String(1)

N

商户传入分期期数时有效。传入: Y,商户贴息,默认用户贴息

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

sub_open_id

买家的支付宝用户 id

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

wx_pub参数

请求参数

参数

类型

必填

描述

open_id

String(128)

Y

微信用户关注商家公众号的 openid

is_raw

String(1)

N

是否原生态:”1”-是,”0”-否

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

wx_app_id

String(128)

N

当前微信小程序的 appid

返回参数

参数

描述

token_id

动态口令, 用于后续接口调用中使用

pay_info

JSON格式 字符串,入参 isRaw=1 该值返回

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 AppID 下的唯一标志

bank_type

支付完成后额外返回付款用户的付款 银行类型

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

wx_lite参数

请求参数

参数

类型

必填

描述

open_id

String(128)

Y

微信用户关注商家公众号的 openid

wx_app_id

String(128)

N

当前微信小程序的 appid

is_raw

String(1)

N

是否原生态:”1”-是,”0”-否

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

Map

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

token_id

动态口令, 用于后续接口调用中使用

pay_info

JSON格式 字符串,入参 isRaw=1 该值返回

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 AppID 下的唯一标志

bank_type

支付完成后额外返回付款用户的付款 银行类型

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

wx_scan参数

请求参数

参数

类型

必填

描述

auth_code

String(128)

Y

扫码设备读出的条形码或者二维码信息

wx_app_id

String(128)

N

微信分配的子商户公众账号ID

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 AppID 下的唯一标志

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

union参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

pay_info

json格式字符串,app 下单成功后返回

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

union_qr参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

qrcode_url

二维码连接

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

union_wap参数

H5支付包含如下步骤(需要域名备案后才可以测试,详见 云闪付入驻):

1.获取临时授权码。浏览器跳转 云闪付授权地址,传入参数:version=1.0.0,redirectUrl=回调地址(商户备案域名下地址),银联返回两个参数respCode(00为成功)、userAuthCode(临时授权码,有效期5分钟)

2.调用 获取银联云闪付用户标识 获取用户ID

3.调用支付接口下单 特别注意:下单接口IP一定是客户手机IP,否则云闪付会拦截

4.用户支付

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

user_identity_id

String(128)

Y

云闪付用户唯一标识,详见 获取银联云闪付用户标识

client_ip

String(46)

Y

实际发起支付的设备ip地址,未正确传入,会导致交易失败

callback_url

String(256)

N

交易完成后跳转的 URL, 需送绝对路径

返回参数

参数

描述

pay_url

支付跳转链接,H5支付下单成功时返回

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

union_scan参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

auth_code

String(128)

Y

扫码设备读出的条形码或者二维码信息

返回参数

参数

描述

couponInfos

优惠券信息,使用 JSON格式

cashPayAmt

现金支付金额

discountAmt

优惠金额

union_online参数

请求参数

参数

类型

必填

描述

client_ip

String(128)

Y

发起支付的用户端ip

callback_url

String(128)

Y

商户前端页面地址,支付成功时,会向该地址跳转

fail_callback_url

String(128)

N

商户前端页面地址,支付失败时,会向该地址跳转(不带交易信息,仅跳转)

返回参数

参数

描述

form_html

银联返回的完整html代码,此页面中含有自动提交脚本

form_encoding

html代码编码格式,使用该字符编码输出html代码至用户浏览器

fast_pay参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

token_no

String(32)

Y

Adapay生成的银行卡唯一标识

b2c参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

acct_issr_id

String(8)

Y

个人网银支持的银行bank_code,详见 网银支持银行列表及限额

card_type

String(32)

Y

银行卡类型:debit-借记卡;credit-贷记卡

client_ip

String(32)

Y

发起支付的用户端ip

callback_url

String(120)

Y

商户前端页面地址,支付成功或失败时,会向该地址跳转

返回参数

参数

描述

trans_assembled_url

Adapay生成的跳转个人网银页面

form_encoding

网银页面编码格式

order_date

当用户支付完成后,前端跳转回商户提供的前端地址后,用于找到原支付交易

order_id

当用户支付完成后,前端跳转回商户提供的前端地址后,用于找到原支付交易

b2b参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

acct_issr_id

String(8)

Y

企业网银支持的银行bank_code,详见 网银支持银行列表及限额

card_type

String(32)

Y

银行卡类型:debit-借记卡

client_ip

String(32)

Y

发起支付的用户端ip

callback_url

String(250)

Y

商户前端页面地址,支付成功或失败时,会向该地址跳转

返回参数

参数

描述

trans_assembled_url

Adapay生成的跳转企业网银页面

form_encoding

网银页面编码格式

order_date

当用户支付完成后,前端跳转回商户提供的前端地址后,用于找到原支付交易

order_id

当用户支付完成后,前端跳转回商户提供的前端地址后,用于找到原支付交易

union_checkout参数

1.请求参数中device_info为必填,其中的device_ip为必填

返回参数

参数

描述

pay_info

json格式字符串,下单成功后返回

PromotionDetail对象

参数

类型

必填

描述

cost_price

String(14)

N

  • 订单原价

  • 商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额

  • 当订单原价与支付金额不相等,则不享受优惠

  • 该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数

receipt_id

String(32)

N

商家小票 id

goods_detail

JSON

Y

订单包含的商品列表信息,详见 GoodsDetail对象

GoodsDetail对象

参数

类型

必填

描述

goods_id

String(32)

Y

商品编码,由半角的大小写字母、数字、中划线、下划线中的一种或几种组成

goods_name

String(256)

Y

商品名称

quantity

String(10)

Y

商品数量

price

String(12)

Y

商品单价,单位为:元。 如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔 100元 的订单使用了商场发的优惠券 100-50,则活动商品的单价应为原单价-50)

goods_category

String(24)

N

商品类目

goods_body

String(1000)

N

商品描述信息

show_url

String(400)

N

商品的展示地址

DeviceInfo 设备信息

参数

类型

必填

描述

device_type

String(2)

N

设备类型,1 :手机, 2 :平板, 3:手表, 4:PC

device_ip

String(64)

Y

交易设备所在的公网 IP

device_id

String(8)

N

终端设备号,收单机构为商户终端分配的唯一编号。当pay_channel的值为alipay_scan或wx_scan时必填。

device_mac

String(64)

N

交易设备 MAC

device_imei

String(64)

N

交易设备 IMEI

device_imsi

String(64)

N

交易设备 IMSI

device_iccId

String(64)

N

交易设备 ICCID

device_wifi_mac

String(64)

N

交易设备 WIFIMAC

device_gps

String(64)

N

交易设备 GPS

DivMembers 分账对象信息

参数

类型

必填

描述

member_id

String(64)

Y

分账用户 Member对象 的 id;若是商户本身时,传入0

amount

String(14)

Y

分账金额,精确到分,如0.50,1.00等,分账总金额必须等于主交易金额,金额不能为0.00

fee_flag

String(1)

N

是否手续费承担方,N-否,Y-是,手续费承担方有且只能有一个

app_id

String(64)

N

控制台 主页面应用的app_id,不上送默认取商户自身app_id

AccountInfo对象

参数

类型

必填

描述

card_id

String(64)

Y

银行卡号

card_name

String(64)

Y

银行卡对应的户名

cert_id

String(64)

N

证件号,银行账户类型为对私时,必填

cert_type

String(2)

N

证件类型,仅支持:00-身份证,银行账户类型为对私时,必填

tel_no

String(64)

Y

手机号

bank_code

String(8)

N

银行编码,详见附录 银行代码,银行账户类型对公时,必填

bank_name

String(64)

N

开户银行名称

bank_acct_type

String(1)

Y

银行账户类型:1-对公;2-对私

prov_code

String(4)

N

银行账户开户银行所在省份编码 (省市编码),银行账户类型为对公时,必填

area_code

String(4)

N

银行账户开户银行所在地区编码(省市编码),银行账户类型为对公时,必填

账务类型 trans_type

属性值

描述

pending

交易处理中

succeeded

交易成功

failed

交易失败

状态 status

属性值

描述

pending

交易处理中

succeeded

交易成功

failed

交易失败

货币代码 currency

属性值

描述

cny

人民币(默认值)

银行类型 bank_type

注: 更多银行类型详见 银行类型列表

银行编码

银行名称

ABC

农业银行

BOC

中国银行

CCB

建设银行

CMB

招商银行

CMBC

民生银行

COMM

交通银行

ICBC

工商银行

PSBC

邮政银行

BOSH

上海银行

PAB

平安银行

银行代码 bank_code

注: 更多银行代码详见 银行列表

银行名称

银行代码

工商银行

01020000

农业银行

01030000

中国银行

01040000

建设银行

01050000

交通银行

03010000

平安银行

03134402

中信银行

03020000

光大银行

03030000

华夏银行

03040000

民生银行

03050000

广发银行

03060000

招商银行

03080000

兴业银行

03090000

浦发银行

03100000

北京银行

03130011

天津银行

03130012

上海银行

03130031

江苏银行

03130032

重庆银行

03130050

大连银行

03132102

哈尔滨银行

03132301

南京银行

03133201

杭州银行

03133301

宁波银行

03133302

温州银行

03133308

恒丰银行

03150000

浙商银行

03160000

一键绑卡支持的银行代码 auto_bank_code

银行名称

银行代码

中国银行

01040000

光大银行

03030000

华夏银行

03040000

广发银行

03060000

浦发银行

03100000

平安银行

03134402

邮政银行

04030000

上海银行

03130031

江苏银行

03130032

南京银行

03133201

渤海银行

03180000

北京银行

03130011

青岛银行

03133702

浙商银行

03160000

兰州银行

04478210