支付宝接入接口文档
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
支付宝接入接口文档
文档历史
目录
微信支付接入接口文档 (1)
1 API介绍 (3)
1.1接口调用方式 (3)
2 API说明 (4)
2.1获取商户开通的支付方式.............................................................. 错误!未定义书签。
2.1.1 功能描述............................................................................... 错误!未定义书签。
2.1.2 访问地址............................................................................... 错误!未定义书签。
2.1.3 请求参数............................................................................... 错误!未定义书签。
2.1.4 应答参数............................................................................... 错误!未定义书签。
2.2扫码支付接口(商户扫消费者) (4)
2.2.1 功能描述 (4)
2.2.2 访问地址 (4)
2.2.3请求参数 (4)
2.2.4 应答参数 (5)
2.3消费撤销 (5)
2.3.1 功能描述 (5)
2.3.2 访问地址 (5)
2.3.3 请求参数 (5)
2.3.4 应答参数 (6)
2.4消费退款........................................................................................... 错误!未定义书签。
2.4.1 功能描述............................................................................... 错误!未定义书签。
2.4.2 访问地址............................................................................... 错误!未定义书签。
2.4.3 请求参数............................................................................... 错误!未定义书签。
2.4.4 应答参数............................................................................... 错误!未定义书签。
2.5已退款订单查询 (6)
2.5.1 功能描述............................................................................... 错误!未定义书签。
2.5.2 访问地址............................................................................... 错误!未定义书签。
2.5.3 请求参数............................................................................... 错误!未定义书签。
2.5.4 应答参数............................................................................... 错误!未定义书签。
2.6订单查询 (6)
2.6.1 功能描述 (6)
2.6.2 访问地址 (6)
2.6.3 请求参数 (6)
2.6.4 应答参数 (6)
2.7扫码支付(消费者扫商户) (6)
2.7.1 功能描述 (7)
2.7.2 访问地址 (7)
2.7.3 请求参数 (7)
2.7.4 应答参数 (7)
2.8 通莞金服支付结果通知 (9)
2.8.1功能描述 (9)
2.8.2访问地址 (9)
2.8.3请求参数 (9)
2.8.4 响应参数 (10)
3 附录 (10)
3.1订单详情OrderInfo 内容................................................................ 错误!未定义书签。
3.2 签名sign算法 (10)
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:
/tgPosp/services/payApi/micropay
2.1.3请求参数
2.2消费撤销
2.2.1 功能描述
针对支付成功的交易,可以调用此接口撤销原交易。
支付完成时间超过四分钟请调用退款接口
2.2.2 访问地址
正式环境请求URL:
测试环境请求URL:
/tgPosp/services/payApi/reverse
2.2.3 请求参数
2.3订单查询
2.3.1 功能描述
用订单号查询订单详情,此接口中下游订单号lowOrderId与通莞金服订单号upOrderId 二选一。
2.3.2 访问地址
正式环境请求URL:
测试环境请求URL:
/tgPosp/services/payApi/orderQuery
2.3.3 请求参数
2.3.4 应答参数
2.4扫码支付(主扫模式)
2.4.1 功能描述
终端机具生成订单二维码让消费者扫,扫码后输入密码即完成支付。
2.4.2 访问地址
正式环境请求URL:
测试环境请求URL:
/tgPosp/services/payApi/unifiedorder
2.4.3 请求参数
2.4.4 应答参数
2.5 支付结果通知
2.5.1功能描述
通莞金服在消费者支付完成之后将订单支付结果通知到下游系统,通知内容为json字符串,字段内容如请求参数所列。
2.5.2访问地址
正式环境请求URL:
测试环境请求URL:
2.5.3请求参数
2.5.4 响应参数
2.6 退款接口
2.6.1功能描述
一、退款方式目前只支持原路返回退款
说明:
退到银行卡则是非实时的,每个银行的处理速度不同,一般发起退款后 1-5个工作日内到账,总退款金额不能超过用户实际支付金额(现金券金额不能退款)
二、退款限制商户在退款操作时应该注意退款限制,避免发起不会成功的退款请求,下面是主要的退款限制:只要退款累计金额不超过交易单支付总额,一笔交易单可以多次退款,退款申请单号(退款接口中有此参数)唯一确定一次退款,而不是交易单号确定一次退款。
退款申请单号由商户生成,所以商户一定要保证退款申请单的唯一性。
商家在退款过程中要特别注意,只有在能确定退款失败的情况下,才能重新发起另一笔退款。
2.目前大多数银行都支持全额退款和部分退款,但是也有少数银行不支持全额退款或部分退款,或者不支持退款。
在这种情况下,商户可以与买家协调,退到微信余额账户中
2.6.2访问地址
正式环境请求URL:
测试环境请求URL:
2.6.3请求参数
2.6.4 响应参数
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。