支付宝接入接口文档.docx
- 文档编号:29248311
- 上传时间:2023-07-21
- 格式:DOCX
- 页数:11
- 大小:18.48KB
支付宝接入接口文档.docx
《支付宝接入接口文档.docx》由会员分享,可在线阅读,更多相关《支付宝接入接口文档.docx(11页珍藏版)》请在冰豆网上搜索。
支付宝接入接口文档
支付宝接入接口文档
文档历史
修订日期
修订内容
修订版本
修订人
2016-08-01
新建
1.0
李洪亮
2017-05-17
更新接口参数列表为全字段签名
1.1
莫晋铭
1API介绍
1.1文档说明及接口调用方式
API调用方式与说明:
Ø所有均采用HTTP方式访问,请求参数和应答参数类型为json格式
Ø提交方法POST,编码为UTF-8
Ø测试信息:
请联系相关接入人员。
Ø接口应答参数中status和message字段不为空,status为本次接口访问的结果标志,message为结果的描述。
100代表成功,其余编码为失败,拥有一系列不同的失败编码,并有相应的message描述。
当status为成功编码时。
为了防止数据在传输过程中被抓包或者篡改,每个接口需要算出签名字段sign,每个接口参与算签名的参数字段都不一样,接口参数列表里“签名”列为“Y”则表示此参数需要参与到签名sign。
有关签名算法参见附录。
2接口列表
2.1扫码支付接口(被扫模式)
2.1.1功能描述
商户使用终端机具或者扫码枪等扫描消费者付款码进行支付,此种属于被扫模式。
2.1.2访问地址
正式环境请求URL:
测试环境请求URL:
http:
//tgjf.833006.biz/tgPosp/services/payApi/micropay
2.1.3请求参数
字段名
中文名
类型
签名
必传
说明
account
商户进件手机号
String
Y
Y
商户进件手机号
payMoney
支付金额
String
Y
Y
单位:
元
lowOrderId
下游订单号
String
Y
Y
下游订单号
barcode
付款码
String
Y
Y
消费者付款码信息
body
商品描述
String
Y
N
商品描述
sign
签名
String
Y
签名
payType
支付方式
String
Y
Y
支付方式0:
微信,1:
支付宝
2.1.4应答参数
字段名
中文名
类型
签名
必传
说明
status
结果
string
Y
Y
100:
成功,101:
失败
message
结果描述
string
Y
Y
错误信息描述
lowOrderId
下游订单号
String
Y
Y
下游订单号
payMoney
支付金额
String
Y
Y
单位:
元
account
商户进件手机号
String
Y
Y
商户进件手机号
UpOrderId
通莞金服订单号
String
Y
Y
通莞金服订单号
state
订单实际支付状态
String
Y
Y
0:
成功,1:
失败,2:
已撤销
sign
签名
String
Y
签名
2.2消费撤销
2.2.1功能描述
针对支付成功的交易,可以调用此接口撤销原交易。
支付完成时间超过四分钟请调用退款接口
2.2.2访问地址
正式环境请求URL:
测试环境请求URL:
http:
//tgjf.833006.biz/tgPosp/services/payApi/reverse
2.2.3请求参数
字段名
中文名
类型
签名
必传
说明
account
商户进件手机号
String
Y
Y
商户进件手机号
upOrderId
通莞金服订单号
String
Y
Y
通莞金服订单号
lowOrderId
下游订单号
String
Y
Y
下游订单号
sign
签名
String
Y
签名
2.2.4应答参数
字段名
中文名
类型
签名
必传
说明
status
结果
string
Y
Y
100:
成功,101:
失败
message
结果描述
string
Y
Y
错误信息描述
account
商户进件手机号
String
Y
Y
商户进件手机号
upOrderId
通莞金服订单号
String
Y
Y
通莞金服订单号
lowOrderId
下游订单号
String
Y
Y
下游订单号
state
订单实际状态
String
Y
Y
0:
成功,1:
失败,2:
已撤销
sign
签名
String
Y
签名
2.3订单查询
2.3.1功能描述
用订单号查询订单详情,此接口中下游订单号lowOrderId与通莞金服订单号upOrderId二选一。
2.3.2访问地址
正式环境请求URL:
测试环境请求URL:
http:
//tgjf.833006.biz/tgPosp/services/payApi/orderQuery
2.3.3请求参数
字段名
中文名
类型
签名
必传
说明
account
商户进件手机号
String
Y
Y
商户进件手机号
lowOrderId
下游订单号
String
Y
Y
下游订单号
upOrderId
通莞金服订单号
String
通莞金服订单号
sign
签名
String
Y
签名
2.3.4应答参数
字段名
中文名
类型
签名
必传
说明
status
结果
string
Y
Y
100:
成功,101:
失败
message
结果描述
string
Y
Y
错误信息描述
lowOrderId
下游订单号
String
Y
Y
下游订单号
payMoney
支付金额
String
Y
Y
单位:
元
account
商户进件手机号
String
Y
Y
商户进件手机号
upOrderId
通莞金服订单号
String
Y
Y
通莞金服订单号
state
订单实际支付状态
String
Y
Y
0:
成功,1:
失败,2:
已撤销
sign
签名
String
Y
签名
2.4扫码支付(主扫模式)
2.4.1功能描述
终端机具生成订单二维码让消费者扫,扫码后输入密码即完成支付。
2.4.2访问地址
正式环境请求URL:
测试环境请求URL:
http:
//tgjf.833006.biz/tgPosp/services/payApi/unifiedorder
2.4.3请求参数
字段名
中文名
类型
签名
必传
说明
account
商户进件手机号
String
Y
Y
商户进件手机号
payMoney
支付金额
String
Y
Y
单位:
元
body
商品订单描述
String
Y
N
商品订单描述
lowOrderId
下游流水号
String
Y
Y
流水号
notifyUrl
下游回调地址
String
Y
Y
下游接收支付结果的url地址
sign
签名
String
Y
签名,算法参见附录
payType
支付方式
String
Y
Y
支付方式0:
微信,1:
支付宝
2.4.4应答参数
字段名
中文名
类型
签名
必传
说明
status
结果
string
Y
Y
100:
成功,101:
失败
message
结果描述
string
Y
Y
错误信息描述
codeUrl
订单二维码url
string
Y
Y
订单二维码url
lowOrderId
下游流水号
String
Y
Y
流水号
account
商户进件手机号
String
Y
Y
商户进件手机号
sign
签名
String
Y
签名,算法参见附录
2.5支付结果通知
2.5.1功能描述
通莞金服在消费者支付完成之后将订单支付结果通知到下游系统,通知内容为json字符串,字段内容如请求参数所列。
2.5.2访问地址
正式环境请求URL:
测试环境请求URL:
2.5.3请求参数
字段名
中文名
类型
签名
必传
说明
lowOrderId
下游系统流水号
String
Y
Y
必须唯一
merchantId
通莞金服商户号
String
Y
Y
通莞金服商户号
payMoney
支付金额
String
Y
Y
单位:
元
upOrderId
通莞金服流水号
String
Y
Y
通莞金服流水号
state
订单状态
String
Y
Y
0:
成功,1:
失败。
orderDesc
订单描述
String
Y
Y
状态为失败时,表示失败原因
sign
签名
String
Y
签名,算法参见附录
2.5.4响应参数
字段名
中文名
类型
签名
必传
说明
lowOrderId
下游系统流水号
String
Y
Y
必须唯一
merchantId
通莞金服商户号
String
Y
Y
通莞金服商户号
finished
是否收到回调
String
Y
Y
SUCCESS表示成功,其他的失败
upOrderId
上游流水号
String
Y
Y
上游流水号
sign
签名
String
Y
签名,算法参见附录
2.6退款接口
2.6.1功能描述
一、退款方式目前只支持原路返回退款
说明:
退到银行卡则是非实时的,每个银行的处理速度不同,一般发起退款后1-5个工作日内到账,总退款金额不能超过用户实际支付金额(现金券金额不能退款)
二、退款限制商户在退款操作时应该注意退款限制,避免发起不会成功的退款请求,下面是主要的退款限制:
只要退款累计金额不超过交易单支付总额,一笔交易单可以多次退款,退款申请单号(退款接口中有此参数)唯一确定一次退款,而不是交易单号确定一次退款。
退款申请单号由商户生成,所以商户一定要保证退款申请单的唯一性。
商家在退款过程中要特别注意,只有在能确定退款失败的情况下,才能重新发起另一笔退款。
2.目前大多数银行都支持全额退款和部分退款,但是也有少数银行不支持全额退款或部分退款,或者不支持退款。
在这种情况下,商户可以与买家协调,退到微信余额账户中
2.6.2访问地址
正式环境请求URL:
测试环境请求URL:
2.6.3请求参数
字段名
中文名
类型
签名
必传
说明
lowOrderId
下游系统流水号
String
Y
Y
必须唯一
merchantId
通莞金服商户号
String
Y
Y
通莞金服商户号
payMoney
支付金额
String
Y
Y
单位:
元
upOrderId
通莞金服流水号
String
Y
Y
通莞金服流水号
state
订单状态
String
Y
Y
0:
成功,1:
失败。
orderDesc
订单描述
String
Y
Y
状态为失败时,表示失败原因
sign
签名
String
Y
签名,算法参见附录
2.6.4响应参数
字段名
中文名
类型
签名
必传
说明
lowOrderId
下游系统流水号
String
Y
Y
必须唯一
merchantId
通莞金服商户号
String
Y
Y
通莞金服商户号
finished
是否收到回调
String
Y
Y
SUCCESS表示成功,其他的失败
upOrderId
上游流水号
String
Y
Y
上游流水号
sign
签名
String
Y
签名,算法参见附录
3附录
3.1签名sign算法
每个接口的参数对应的“签名”列的内容为“Y”时,表示该字段参与签名,按照字母ascii升序并以&符号拼接后再拼接上通莞金服下发的key,进行MD5加密再转成大写字符串。
例:
某渠道key=123qwe,某接口有4个参数都参与签名,ac=xxx,ab=xxx,c=xxx,b=xxx,按照ascii升序拼接后为:
ab=xxx&ac=xxx&b=xxx&c=xxx
再拼接key
ab=xxx&ac=xxx&b=xxx&c=xxx&key=123qwe
最后对上述字符串进行MD5操作后转成大写即得到签名sign
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 支付 接入 接口 文档
![提示](https://static.bdocx.com/images/bang_tan.gif)