开发文档-凯发在线平台

协议规则

请求数据格式:application/x-www-form-urlencode

返回数据格式:json

签名算法:md5

字符编码:utf-8

页面跳转支付

此接口可用于用户前台直接发起支付,使用form表单跳转或拼接成url跳转。

url地址:https://pay.fanxiy.cn/submit.php

请求方式:post 或 get(推荐post,不容易被劫持或屏蔽)

请求参数说明:

字段名变量名必填类型示例值描述
商户idpidint1001
凯发在线平台的支付方式typestringalipay
商户订单号out_trade_nostring20160806151343349
异步通知地址notify_urlstringhttp://www.pay.com/notify_url.php服务器异步通知地址
跳转通知地址return_urlstringhttp://www.pay.com/return_url.php页面跳转通知地址
商品名称namestringvip会员如超过127个字节会自动截取
商品金额moneystring1.00单位:元,最大2位小数
业务扩展参数paramstring没有请留空支付后原样返回
签名字符串signstring202cb962ac59075b964b07152d234b70签名算法
签名类型sign_typestringmd5默认为md5

凯发在线平台的支付方式(type)不传会跳转到收银台支付

api接口支付

此接口可用于服务器后端发起支付请求,会返回支付二维码链接或支付跳转url。

url地址:https://pay.fanxiy.cn/mapi.php

请求方式:post

请求参数说明:

字段名变量名必填类型示例值描述
商户idpidint1001
凯发在线平台的支付方式typestringalipay
商户订单号out_trade_nostring20160806151343349
异步通知地址notify_urlstringhttp://www.pay.com/notify_url.php服务器异步通知地址
跳转通知地址return_urlstringhttp://www.pay.com/return_url.php页面跳转通知地址
商品名称namestringvip会员如超过127个字节会自动截取
商品金额moneystring1.00单位:元,最大2位小数
用户ip地址clientipstring192.168.1.100用户发起支付的ip地址
设备类型devicestringpc根据当前用户浏览器的ua判断,
传入用户所使用的浏览器
或设备类型,默认为pc
业务扩展参数paramstring没有请留空支付后原样返回
签名字符串signstring202cb962ac59075b964b07152d234b70签名算法
签名类型sign_typestringmd5默认为md5

返回结果(json):

字段名变量名类型示例值描述
返回状态码codeint11为成功,其它值为失败
返回信息msgstring失败时返回原因
订单号trade_nostring20160806151343349支付订单号
支付跳转urlpayurlstringhttps://pay.fanxiy.cn/pay/wxpay/202010903/如果返回该字段,则直接跳转到该url支付
二维码链接qrcodestringweixin://wxpay/bizpayurl?pr=04ipmkm如果返回该字段,则根据该url生成二维码
小程序跳转urlurlschemestringweixin://dl/business/?ticket=xxx如果返回该字段,则使用js跳转该url,可发起微信小程序支付

注:payurl、qrcode、urlscheme 三个参数只会返回其中一个

支付结果通知

通知类型:服务器异步通知(notify_url)、页面跳转通知(return_url)

请求方式:get

请求参数说明:

字段名变量名必填类型示例值描述
商户idpidint1001
易支付订单号trade_nostring20160806151343349021梵星pay聚合收款订单号
商户订单号out_trade_nostring20160806151343349商户系统内部的订单号
凯发在线平台的支付方式typestringalipay
商品名称namestringvip会员
商品金额moneystring1.00
支付状态trade_statusstringtrade_success只有trade_success是成功
业务扩展参数paramstring
签名字符串signstring202cb962ac59075b964b07152d234b70签名算法
签名类型sign_typestringmd5默认为md5

收到异步通知后,需返回success以表示服务器接收到了订单通知

md5签名算法

1、将发送或接收到的所有参数按照参数名ascii码从小到大排序(a-z),sign、sign_type、和空值不参与签名!

2、将排序后的参数拼接成url键值对的格式,例如 a=b&c=d&e=f,参数值不要进行url编码。

3、再将拼接好的字符串与商户密钥key进行md5加密得出sign签名参数,sign = md5 ( a=b&c=d&e=f key ) (注意: 为各语言的拼接符,不是字符!),md5结果为小写。

4、具体签名与发起支付的示例代码可下载sdk查看。

凯发在线平台的支付方式列表

调用值描述
alipay支付宝
wxpay微信支付
qqpayqq钱包

设备类型列表

调用值描述
pc电脑浏览器
mobile手机浏览器
qq手机qq内浏览器
wechat微信内浏览器
alipay支付宝客户端

[api]查询商户信息

url地址:https://pay.fanxiy.cn/api.php?act=query&pid={商户id}&key={商户密钥}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actstringquery此api固定值
商户idpidint1001
商户密钥keystring89unjub8hz54hj7x4nuj56hn4nuzuj8i

返回结果:

字段名变量名类型示例值描述
返回状态码codeint11为成功,其它值为失败
商户idpidint1001商户id
商户密钥keystring(32)89unjub8hz54hj7x4nuj56hn4nuzuj8i商户密钥
商户状态activeint11为正常,0为封禁
商户余额moneystring0.00商户所拥有的余额
结算方式typeint11:支付宝,2:微信,3:qq,4:银行卡
结算账号accountstringadmin@pay.com结算的支付宝账号
结算姓名usernamestring张三结算的支付宝姓名
订单总数ordersint30订单总数统计
今日订单order_todayint15今日订单数量
昨日订单order_lastdayint15昨日订单数量

[api]查询结算记录

url地址:https://pay.fanxiy.cn/api.php?act=settle&pid={商户id}&key={商户密钥}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actstringsettle此api固定值
商户idpidint1001
商户密钥keystring89unjub8hz54hj7x4nuj56hn4nuzuj8i

返回结果:

字段名变量名类型示例值描述
返回状态码codeint11为成功,其它值为失败
返回信息msgstring查询结算记录成功!
结算记录dataarray结算记录列表

[api]查询单个订单

url地址:https://pay.fanxiy.cn/api.php?act=order&pid={商户id}&key={商户密钥}&out_trade_no={商户订单号}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actstringorder此api固定值
商户idpidint1001
商户密钥keystring89unjub8hz54hj7x4nuj56hn4nuzuj8i
系统订单号trade_no选择string20160806151343312
商户订单号out_trade_no选择string20160806151343349

提示:系统订单号 和 商户订单号 二选一传入即可,如果都传入以系统订单号为准!

返回结果:

字段名变量名类型示例值描述
返回状态码codeint11为成功,其它值为失败
返回信息msgstring查询订单号成功!
易支付订单号trade_nostring2016080622555342651梵星pay聚合收款订单号
商户订单号out_trade_nostring20160806151343349商户系统内部的订单号
第三方订单号api_trade_nostring20160806151343349支付宝微信等接口方订单号
凯发在线平台的支付方式typestringalipay
商户idpidint1001发起支付的商户id
创建订单时间addtimestring2016-08-06 22:55:52
完成交易时间endtimestring2016-08-06 22:55:52
商品名称namestringvip会员
商品金额moneystring1.00
支付状态statusint01为支付成功,0为未支付
业务扩展参数paramstring默认留空
支付者账号buyerstring默认留空

[api]批量查询订单

url地址:https://pay.fanxiy.cn/api.php?act=orders&pid={商户id}&key={商户密钥}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actstringorders此api固定值
商户idpidint1001
商户密钥keystring89unjub8hz54hj7x4nuj56hn4nuzuj8i
查询订单数量limitint20返回的订单数量,最大50
页码pageint1当前查询的页码

返回结果:

字段名变量名类型示例值描述
返回状态码codeint11为成功,其它值为失败
返回信息msgstring查询结算记录成功!
订单列表dataarray订单列表

[api]提交订单退款

需要先在商户后台开启订单退款api接口开关,才能调用该接口发起订单退款

url地址:https://pay.fanxiy.cn/api.php?act=refund

请求方式:post

请求参数说明:

字段名变量名必填类型示例值描述
商户idpidint1001
商户密钥keystring89unjub8hz54hj7x4nuj56hn4nuzuj8i
易支付订单号trade_no特殊可选string20160806151343349021易支付订单号
商户订单号out_trade_no特殊可选string20160806151343349订单支付时传入的商户订单号,商家自定义且保证商家系统中唯一
退款金额moneystring1.50少数通道需要与原订单金额一致

注:trade_no、out_trade_no 不能同时为空,如果都传了以trade_no为准

返回结果:

字段名变量名类型示例值描述
返回状态码codeint11为成功,其它值为失败
返回信息msgstring退款成功

sdk下载

sdk.zip
zip文件
6.9k
免责声明: 本文来自梵星网创作者,不代表梵星网的观点和立场。 本网页内容均来自网络采集,如果侵犯了您的权益请与我司联系。
the end
分享