智付30网银支付接口文档V305.docx
- 文档编号:23857435
- 上传时间:2023-05-21
- 格式:DOCX
- 页数:30
- 大小:349.14KB
智付30网银支付接口文档V305.docx
《智付30网银支付接口文档V305.docx》由会员分享,可在线阅读,更多相关《智付30网银支付接口文档V305.docx(30页珍藏版)》请在冰豆网上搜索。
智付30网银支付接口文档V305
文件名称
密级
网银网关支付接口规范
保密
文件版本
共22页
V300R005
网银网关支付接口规范
深圳市快汇宝信息技术有限公司
版权所有XX
网银网关支付接口规范1
1.概述3
1.1.目的3
1.2.术语与缩略语3
1.3.文档约束3
1.4.接口清单3
1.5.典型业务流程4
1.6.获取商户号和支付密钥4
2.接口定义5
2.1.B2C支付交易接口5
2.1.1.描述5
2.1.2.接口参数定义5
2.1.3.错误码定义8
2.2.B2B支付交易接口8
2.2.1.描述8
2.2.2.接口参数定义8
2.2.3.错误码定义10
2.3.支付结果通知接口10
2.3.1.描述10
2.3.2.接口参数定义11
2.4.单笔交易查询接口12
2.4.1.描述12
2.4.2.接口参数定义13
2.4.3.响应参数定义13
2.5.附录16
2.5.1.网关地址16
2.5.2.签名规则定义16
2.5.3.B2C银行代码对照表16
2.5.4.B2B银行代码对照表17
2.5.5.错误码定义18
2.5.6.常见问题21
概述
目的
本文档定义了如下接口:
商户网站与智付支付平台间的B2C与B2B支付接口、商户网站与智付支付平台间的支付结果通知接口(包括:
页面跳转同步通知接口、服务器异步通知接口)、商户网站与智付支付平台间的交易查询接口。
术语与缩略语
商户号:
商户注册的智付平台的唯一标识账号。
商户密钥:
商户与智付合作,商户可在商户后台()自行设定的密串,初始值是空的,密钥由数字、字母和下划线组成,不少于20位,密钥是商家使用智付提供的加密控件对订单信息进行加密和签名、智付返回支付结果给商家的密文进行解密和验证签名的钥匙。
页面通知:
页面跳转同步通知,智付获取数据处理完成之后,会在几秒之后(或者用户手动点击)从智付支付页面跳转至商户指定的页面,同时会携带处理完成之后的反馈信息,包含的信息和后台通知地址信息一致。
比如:
后台通知:
服务器异步通知,智付获取数据处理完成之后,智付服务器会主动向商户网站指定的地址发送通知,携带处理完的订单信息,正确的做法是在这里进行网站订单的管理操作,包含的信息和页面通知信息一致。
比如:
文档约束
接口清单
序号
接口名称
接口描述
1
商户网站与智付支付平台间的B2C支付接口
定义商户网站与智付支付平台间的B2C支付交易接口。
2
商户网站与智付支付平台间的B2B支付接口
定义商户网站与智付支付平台间的B2C支付交易接口。
3
商户网站与智付支付平台间的支付结果通知接口
定义商户网站与智付支付平台间的支付结果通知接口,包括:
页面跳转同步通知接口、服务器异步通知接口。
4
商户网站与智付支付平台间的交易查询接口
定义商户网站与智付支付平台间的单笔交易查询接口。
典型业务流程
获取商户号和支付密钥
步骤一、商户资质审核通过之后,开户成功,商户会收到智付支付平台下发的包括商户号、用户名和登录密码的邮件,登录智付支付平台的商户登录首页,输入商家号、用户名和登录密码;
步骤二、登录商户后台,打开支付管理->支付设置,设置支付密钥,点击修改密钥,修改即可;
密钥格式:
数字+字母+下划线20位以上,例如:
123abc456efg789hmn_kdsc
接口定义
B2C支付交易接口
描述
定义商户网站与智付支付平台间的B2C支付交易接口,商户网站按照接口规范定义将交易订单数据提交到智付支付网关,以HTTPSPOST方式提交数据。
接口参数定义
交易请求地址:
例如:
input_charset与请求参数中的参数编码字符集相一致,仅限于UTF-8、GBK、GB2312。
支付请求参数定义如下:
参数
参数名称
类型(长度)
使用
说明
基本参数
service_type
业务类型
String
必选
固定值:
direct_pay
merchant_code
商家号
String(10)
必选
商户签约时,智付支付平台分配的唯一商家号,举例:
1111110166。
input_charset
参数编码字符集
String
必选
取值:
UTF-8、GBK(必须大写)。
notify_url
服务器异步通知地址
String(200)
必选
支付成功后,智付支付平台会主动通知商家系统,商家系统必须指定接收通知的地址,举例:
return_url
页面跳转同步通知地址
String(200)
可选
支付成功后,通过页面跳转的方式跳转到商家网站,举例:
client_ip
客户端IP
String(15)
可选
用户创建交易时,该用户当前所使用机器的IP,举例:
192.168.1.25,最大长度为15个字符。
interface_version
接口版本
String
必选
接口版本,固定值:
V3.0(必须大写)
sign_type
签名方式
String
必选
默认值:
MD5,目前仅支持MD5,不参与签名
sign
签名
String
必选
签名数据,具体请见下面的签名规则
业务参数
order_no
商户网站唯一订单号
String(64)
必选
商户系统订单号,由商户系统生成,保证其唯一性,最长64位,由字母、数字组成.举例:
1000201555。
order_time
商户订单时间
Date
必选
商户订单时间,格式:
yyyy-MM-ddHH:
mm:
ss,举例:
2013-11-0112:
34:
58
order_amount
商户订单总金额
Number
必选
该笔订单的总金额,以元为单位,精确到小数点后两位,举例:
12.01。
product_name
商品名称
String(100)
必选
商品名称,不超过100个字符
举例:
华硕G750Y47JX-BL。
show_url
商品展示URL
String(200)
可选
商品展示地址,不超过200个字符举例:
。
product_code
商品编号
String(30)
可选
商品编号,不超过60个字符,举例:
B001
product_num
商品数量
Number
可选
商品数量,必须是数字
product_desc
商品描述
String(300)
可选
商品描述,不超过300个字符,举例:
商品描述
bank_code
银行代码
String
可选
参见B2C银行代码对照表,当该参数为空并与对照表中银行编码不一致,则直接跳转到银行支付页面。
extra_return_param
公用回传参数
String(100)
可选
如果支付请求时传递该参数,则通知商户支付成功时回传该参数。
extend_param
公用业务扩展参数
String
可选
参数格式:
参数名1^参数值|参数名2^参数值2,多条数据间用"|"间隔,举例:
name^张三|sex^男。
公用业务扩展参数定义如下(extend_param):
参数
参数名称
类型(长度)
使用
说明
收货人信息
ship_to_name
收货人姓名
String(50)
可选
ship_to_email
收货人邮箱
String(60)
可选
ship_to_phone
收货人电话
String(30)
可选
ship_to_state
收货地址省
String
可选
ship_to_city
收货地址城市
String
可选
ship_to_street
收货人详细地址
String
可选
ship_to_zip
收货地址邮编
String
可选
消费者信息
customer_email
用户邮箱
String
可选
customer_name
用户姓名
String
可选
customer_phone
用户电话或手机号码
String
可选
customer_state
用户所在省
String
可选
customer_city
用户所在城市
String
可选
customer_street
用户详细地址
String
可选
customer_zip
地址邮政编码
String
可选
错误码定义
参见附录中的错误码定义
B2B支付交易接口
描述
定义商户网站与智付支付平台间的B2B支付交易接口,商户网站按照接口规范定义将交易订单数据提交到智付支付网关,以HTTPSPOST方式提交数据。
接口参数定义
交易请求地址:
例如:
input_charset与请求参数中的参数编码字符集相一致,仅限于UTF-8、GBK。
支付请求参数定义如下:
参数
参数名称
类型(长度)
使用
说明
基本参数
service_type
业务类型
String
必选
固定值:
b2b_pay
merchant_code
商家号
String
必选
商户签约时,智付支付平台分配的唯一商家号,长度10位,例如:
1111110166。
input_charset
参数编码字符集
String
必选
取值:
UTF-8、GBK。
notify_url
服务器异步通知地址
String(200)
必选
支付成功后,智付支付平台会主动通知商家系统,商家系统必须指定接收通知的地址,举例:
return_url
页面跳转同步通知地址
String(200)
可选
支付成功后,通过页面跳转的方式跳转到商家网站,举例:
client_ip
客户端IP
String(15)
可选
用户创建交易时,该用户当前所使用机器的IP,举例:
192.168.1.25。
interface_version
接口版本
String
必选
接口版本,固定值:
V3.0
sign_type
签名方式
String
必选
默认值:
MD5,目前仅支持MD5,不参与签名
sign
签名
String
必选
签名数据,具体请仔细阅读上面的签名规则。
业务参数
order_no
商户网站唯一订单号
String(64)
必选
商户系统订单号,由商户系统保证唯一性,最长64位字母、数字组成,举例:
1000201555。
order_time
商户订单时间
Date
必选
商户订单时间,格式:
yyyy-MM-ddHH:
mm:
ss,举例:
2013-11-0117:
34:
56。
order_amount
商户订单总金额
Number
必选
该笔订单的总金额,以元为单位,精确到小数点后两位,举例:
12.01。
product_name
商品名称
String(100)
必选
商品名称,不超过100个字符,举例:
华硕G750Y47JX-BL。
show_url
商品展示URL
String(200)
可选
商品展示地址,举例:
http:
//www.dinpay.coom
product_code
商品编号
String(30)
可选
商品编号,不超过60个字符,举例:
10010。
product_num
商品数量
Number
可选
商品数量,举例:
11。
product_desc
商品描述
String(300)
可选
商品描述,不超过300个字符,举例:
商品描述。
bank_code
银行代码
String
可选
参见B2B银行代码对照表,当该参数不为空并与对照表中银行编码一致,则直接跳转到银行支付页面,举例:
ABC。
extra_return_param
公用回传参数
String(100)
可选
如果支付请求时传递该参数,则通知商户支付成功时回传该参数,举例:
快汇宝智付
extend_param
公用业务扩展参数
String
可选
参数格式:
参数名1^参数值|参数名2^参数值2,多条数据间用"|"间隔,举例:
name^张三|sex^男。
公用业务扩展参数定义如下(extend_param):
参数
参数名称
类型(长度)
使用
说明
收货人信息
ship_to_name
收货人姓名
String(50)
可选
ship_to_email
收货人邮箱
String(60)
可选
ship_to_phone
收货人电话
String(30)
可选
ship_to_state
收货地址省
String
可选
ship_to_city
收货地址城市
String
可选
ship_to_street
收货人详细地址
String
可选
ship_to_zip
收货地址邮编
String
可选
错误码定义
参见附录中的错误码定义
支付结果通知接口
描述
定义商户网站与智付支付平台间的支付结果通知接口,包括:
页面跳转同步通知接口、服务器异步通知接口,用于消费者支付成功后,通过页面跳转方式和服务器异步通知方式通知商户网站该笔交易支付成功,默认情况下只有支付成功才会通知。
当通知方式为服务器异步通知时,商户系统在收到后台通知并处理完成后必须打印输出SUCCESS,如果不是这7个字符,智付支付系统会在随后的一段时间内,以递增的时间间隔重发5次通知,时间间隔(5m/10m/20m/30m)。
接口参数定义
请求参数定义如下:
参数
参数名称
类型(长度)
使用
说明
基本参数
merchant_code
商家号
String
必选
商户签约时,智付支付平台分配的唯一商家号,举例:
1111110166。
notify_type
通知类型
String
必选
取值如下:
页面跳转通知:
page_notify
服务器异步通知:
offline_notify
notify_id
通知校验ID
String
必选
建议商家系统接收到此通知消息后,用此校验ID向智付支付平台校验此通知的合法性,由32位不重复的数字、字母组成.举例:
235dst58fd1dwe21354fdafdaesfdsaf。
interface_version
接口版本
String
必选
接口版本,固定值:
V3.0
sign_type
签名方式
String
必选
默认值:
MD5,目前仅支持MD5,不参与签名
sign
签名
String
必选
签名数据,具体仔细阅读下面的签名规则.
业务参数
order_no
商户网站唯一订单号
String(64)
必选
商户系统订单号,由商户系统保证唯一性,最长64位字母、数字组成,举例:
1000201555。
order_time
商户订单时间
Date
必选
商户订单时间,格式:
yyyy-MM-ddHH:
mm:
ss,举例:
2013-11-0112:
34:
54。
order_amount
商户订单总金额
Number
必选
该笔订单的总金额,以元为单位,精确到小数点后两位,举例:
12.01。
extra_return_param
公用回传参数
String(100)
可选
如果支付请求时传递该参数,则通知商户支付成功时回传该参数,举例:
快汇宝智付。
trade_no
智付交易订单号
String
必选
智付交易订单号,举例:
1000004817
trade_time
智付交易订单时间
Date
必选
智付交易订单时间,格式为:
yyyy-MM-ddHH:
mm:
ss,举例:
2013-12-0112:
23:
34。
trade_status
交易状态
String
必选
该笔订单交易状态
SUCCESS交易成功
FAILED交易失败
bank_seq_no
网银交易流水号
String
可选
银行交易流水号,举例:
2013060911235456。
说明:
当通知类型为offline_notify,商户系统接收到通知后必须返回处理结果SUCCESS,如果不是这7个字符,支付平台会重发5次通知,如果通知成功(即收到SUCCESS响应),通知ID参数失效,重发5次通知后,通知ID参数也会失效。
单笔交易查询接口
描述
定义商户网站与智付支付平台间的单笔交易查询接口。
接口参数定义
请求地址:
参数定义如下:
参数
参数名称
类型(长度)
使用
说明
基本参数
service_type
业务类型
String
必选
固定值:
single_trade_query,
merchant_code
商家号
String
必选
支付平台分配的唯一商家号,举例:
1111110166。
interface_version
接口版本
String
必选
接口版本,固定值:
V3.0
sign_type
签名方式
String
必选
默认值:
MD5,目前仅支持MD5,不参与签名
sign
签名
String
必选
签名数据,具体请仔细阅读下面的签名规则。
业务参数
order_no
商户网站唯一订单号
String
必选
商户系统订单号,举例:
2013-09-0812:
13:
14。
trade_no
智付交易订单号
String
可选
智付交易订单号,举例:
1000004817。
响应参数定义
以XML格式形式同步返回响应数据:
参数
参数名称
类型(长度)
使用
说明
基本参数
is_success
查询是否成功
String
必选
仅表示查询是否成功
T代表成功
F代表失败
sign_type
签名方式
String
必选
默认值:
MD5,目前仅支持MD5,不参与签名
sign
签名
String
必选
签名数据,具体请仔细阅读下面的签名规则。
error_code
错误码
String
可选
当查询失败时才返回错误码。
举例:
128600。
业务参数(is_success值为T)
merchant_code
商家号
String
必选
支付平台分配的唯一商家号,举例:
1111110166。
order_no
商户网站唯一订单号
String
必选
商户系统订单号,举例:
1000201555。
order_time
商户订单时间
Date
必选
商户订单时间,格式:
yyyy-MM-ddHH:
mm:
ss,举例:
2013-12-0112:
23:
34。
order_amount
商户订单总金额
Number
必选
该笔订单的总金额,以元为单位,精确到小数点后两位,举例:
12.01。
trade_no
智付交易订单号
String
必选
智付交易订单号,举例:
1000004817。
trade_time
智付交易订单时间
Date
必选
智付交易订单时间,格式为:
yyyy-MM-ddHH:
mm:
ss,举例:
2013-12-0112:
23:
34。
trade_status
交易状态
String
必选
该笔订单交易状态
SUCCESS交易成功
FAILED交易失败
UNPAY未支付
bank_code
支付银行代码
String
可选
用户实际选择的支付银行
参见银行代码对照表,举例:
ABC。
bank_seq_no
网银交易流水号
String
可选
银行交易流水号举例:
2013060911235456。
当查询成功时,返回XML数据如下:
xmlversion="1.0"encoding="UTF-8"?
>
18:
00
20:
01
当查询失败时,返回XML数据如下:
xmlversion="1.0"encoding="UTF-8"?
>
附录
网关地址
如果未做特殊说明,智付支付网关统一地址为:
,查询网关统一地址为:
。
签名规则定义
签名规则定义如下:
Ø参数列表中,除去sign_type、sign两个参数外,其它所有不为空的参数都要参与签名,值为空的参数不用参与签名;
Ø签名顺序
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 30 支付 接口 文档 V305