目录
支付接入文档 1
前言 3
概述 3
术语 3
1. 接口总述 3
接口规范 3
通讯方式及安全 3
1. 公共字段列表 3
2. 接口 4
注册机器 4
查询机器信息 4
心跳 6
停止心跳 6
上传支付链接接口 7
上传支付订单结果 7
上传提现订单接口 8
版本信息
版本号 |
修改人 |
修改内容 |
说明 |
V1.0 |
LORI |
起草接口文档 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
本文档规定了第三方平台接入支付系统使用的报文接口说明等。
1、支付系统第三方接口目前均采用http协议,接口采用普通form post形式 (个别除外)
2、所有接入的商家,支付将分配 商户号(merchantNo)及签名密钥(key),签名(sign字段)统一采用MD5 后转大写
3、接口所有数据编码采用UTF-8格式。
4、返回都是json
秘钥; gAefyHG2h2GOfUTU
采用md5加密
把 nonceStr + 秘钥 加密,加密后作为 sign
公共请求字段
字段 |
是否必须 |
说明 |
machineNo |
是 |
机器号 |
aliPayAccount
|
是 |
支付宝账号 |
sign |
是 |
签名 |
nonceStr |
是 |
随机字符串 |
公共响应字段:
字段 |
是否必须 |
说明 |
statusCode
|
是 |
通信标识,值 SUCCESS或者FAIL . 当值为FAIL时其他业务字段的值没意义 |
message |
是 |
对此次通信的描述,当returnCode为FAIL,具有意义 |
data |
是 |
json |
说明:
把该机器关联的支付宝信息注册到服务器端
接口地址:/admin_itg/alipay/register_machine
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
mchid |
String |
20 |
合作商ID |
Y |
userName |
String |
50 |
支付宝持有人姓名 |
N |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
|
|
|
|
|
|
|
|
|
|
接口地址:/admin_itg/alipay/query_machine_info
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
|
|
|
|
|
响应说明:
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
withdraw_amount |
int |
11 |
多少钱提现一次(单位元) |
Y |
withdraw_remain_amount |
Int |
11 |
提现保留多少钱不要提(元) |
Y |
damimi |
String |
50 |
支付宝提现密码(base64编码) |
Y |
temp_withdraw_flag |
String |
50 |
服务器端临时发起提现的标识,如果是Y ,则app做提现动作,N 则不用管 |
Y |
heartbeat_time |
int |
11 |
心跳时间间隔(秒) |
Y |
money_list |
Array |
|
要生成面值的数组,可能是空 |
N |
amount |
Int |
|
金额(单位分) |
Y |
remark |
String |
|
备注 |
Y |
|
|
|
|
|
响应:
{
"data":{
"money_list":[
{
"amount":1000,
"remark":"146-10-1"
},
{
"amount":1000,
"remark":"147-10-2"
}
],
"heartbeat_time":60,
"withdraw_amount":10,
"withdraw_remain_amount":1,
"damimi":"MTE=",
"temp_withdraw_flag":"Y"
},
"message":"查询成功",
"statusCode":"SUCCESS"
}
每隔一段时间给服务器发心跳,以便服务器得知机器状况
接口地址:/admin_itg/alipay/heartbeat
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
balance |
String |
|
余额(单位 分) |
Y |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
|
|
|
|
|
|
|
|
|
|
当机器出现异常,主动停止机器,这样机器就不会继续收款
接口地址:/admin_itg/alipay/stop_heartbeat
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
balance |
String |
|
余额(单位 分) |
Y |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
把生成好的二维码上传上来
接口地址:/admin_itg/alipay/upload_qrcode
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
remark |
String |
50 |
备注 |
y |
amount |
String |
10 |
金额(单位分) |
y |
qrCodeUrl |
String |
500 |
支付宝二维码 |
y |
报文样例:
接口地址:/admin_itg/alipay/payment_return
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
amount |
String |
|
金额(分) |
y |
aliPayOrderNo |
String |
50 |
支付宝订单号 |
y |
payUserName |
String |
50 |
支付人姓名 |
y |
payUserAliAccount |
String |
50 |
支付人账号 |
y |
remark |
String |
50 |
二维码唯一备注 |
y |
orderTime |
String |
50 |
收款时间,格式:2018-11-12 16:50:29 |
|
returnContent |
String |
2048 |
支付宝回来的报文 |
n |
|
|
|
|
y |
报文样例:
{
"machineNo": "1001",
"aliPayAccount": "122222",
"qrcodeList": [
{
"remark": "146-10-1",
"amount": "1000",
"qrCodeUrl": "http://www.qq.com"
},
{
"remark": "146-10-2",
"amount": "1000",
"qrCodeUrl": "http://www.baid.com"
}
]
}
接口地址:/admin_itg/alipay/withdraw_return
输入参数
字段名 |
类型 |
最大允许长度 |
说明 |
是否必填 |
machineNo |
String |
20 |
机器号 |
Y |
aliPayAccount |
String |
50 |
支付宝号 |
Y |
nonceStr |
String |
20 |
随机字符串(公共字段) |
Y |
sign |
String |
200 |
签名(公共字段) |
Y |
remark |
String |
50 |
订单备注 |
n |
amount |
String |
10 |
金额(单位分) |
y |
orderType |
String |
20 |
订单类型: 代付 WITHDRAW 手续费COST |
y |
alipayOrgOrderNo
|
String |
50 |
支付宝订单号 |
y |
refOrderNo
|
String |
50 |
关联的支付宝订单号(手续费时填,允许为空) |
n |
orderTime
|
String |
20 |
订单时间 格式 2018-09-27 23:54:39 |
y |
最新新增以下接口
1.查询机器信息接口多了传入 不设金额的收款码链接,也就是填完信息进入app后要多拉一次不设金额的收款码
2.上传支付结果接口增加了流水号
3.加一个查看运行日志都界面
4.注册接号口增加了version版本号字段
5.防调单方案修改
6.手动上传调单的按钮
需要本套APP开源源码的联系 素材火官网客服:https://www.sucaihuo.com/source