Python轻量级支付整合SDK:统一API与多方式集成指南
本文介绍一款Python轻量级支付整合集成工具,旨在实现支付与业务逻辑完全剥离。该工具屏蔽了不同支付方式API及数据结构的差异,提供统一的API接口和数据结构,支持电脑网站、手机网站、APP等多种支付类型,并具备横向扩展能力。通过统一异常处理和Builder模式,开发者可快速完成支付模块开发,支持异步通知校验、交易查询、退款等通用及平台特有功能。
本工具采用轻量级架构进行支付方式整合集成,核心目标是实现支付功能与业务逻辑的完全解耦,从而帮助开发者快速且简单地完成支付模块的开发工作。
主要特性
- 屏蔽不同支付方式在接入API和数据结构上的差异,提供统一的API接口和数据结构。
- 支持支付类型的横向扩展,便于后续新增支付方式。
- 提供统一的异常处理机制,简化错误排查与处理流程。
支持多种支付方式及功能,具体包括以下类别。
支持的支付方式
- 支付宝支付(pay_type=ali_pay)
- 微信支付(pay_type=wx_pay)
通用功能
- 电脑网站支付
- 手机网站支付
- APP支付
- 异步通知校验
- 交易查询
- 交易取消
- 退款
- 退款查询
平台特有功能
- 微信JS支付
- 微信企业付款到零钱
使用说明
安装
# installation pip install all-pay --upgrade
核心说明
配置参数(dict)
ALIPAY_CONFIG = {
'pay_type': 'ali_pay', # 必填 区分支付类型
'app_id': 'xxx', #必填 应用id
'private_key_path': 'xxx', #必填 私钥
'public_key_path': 'xxx',#必填 公钥
'notify_url': 'xxx',# 异步回调地址
'sign_type': 'RSA2', # 签名算法 RSA 或者 RSA2
'debug': False, # 是否是沙箱模式
}
WECHAT_CONFIG = {
'pay_type': 'wx_pay', # 必填 区分支付类型
'app_id': 'xxx', # 必填,应用id
'mch_key': 'xxx', # 必填,商户平台密钥
'mch_id': 'xxx', # 必填,微信支付分配的商户号
'app_secret': 'xxx', # 应用密钥
'notify_url': 'xxx'# 异步回调地址
'api_cert_path': 'xxx', # API证书
'api_key_path': 'xxx' # API证书 key
}
其中 pay_type 为本项目必需字段,用于区分具体的支付类型;其余参数为对应支付方式所需的配置项,具体请参考各支付方式对应的官方文档。
Pay类
作为支付网关,负责支付方式的分配和请求转发入口。
PayOrder类
统一封装支付订单信息,主要用于生成支付下单请求。
order = PayOrder.Builder().subject('商品标题') .out_trade_no('商品订单号').total_fee('商品费用').build()
通过 Builder模式结合链式调用,灵活组合通用参数和特殊参数。更多参数说明参见源码。
PayResponse类
统一封装支付返回的业务信息,主要用于支付查询操作。
生成统一回单示例
response = PayResponse.Builder().trade_no('平台订单号').out_trade_no('商家订单号').build()
通过 Builder模式结合链式调用,灵活组合通用参数和特殊参数。更多参数说明参见源码。
Demo示例
from all_pay import PayOrder
from all_pay import Pay
ALIPAY_CONFIG = {
'pay_type': 'ali_pay', # 必填 区分支付类型
'app_id': 'xxx', #必填 应用id
'private_key_path': 'xxx', #必填 私钥
'public_key_path': 'xxx',#必填 公钥
'notify_url': 'xxx',# 异步回调地址
'sign_type': 'RSA2', # 签名算法 RSA 或者 RSA2
'debug': False, # 是否是沙箱模式
}
# 额外参数,某些支付方式有些选填的参数在PayOrder并没有封装,可以自行传递
extra_params= {
'xxx':'xxx'
'xxx':'xxx'
'xxx':'xxx'
}
order = PayOrder.Builder().subject('商品标题') .out_trade_no('商品订单号').total_fee('商品费用').build()
pay = Pay(ALIPAY_CONFIG) # 传入对应支付方式配置
order_res= pay.trade_page_pay(order,extra_params)# 传入对应订单和额外参数(要是需要)
功能说明
电脑网站支付 [trade_page_pay]
pay = Pay(ALIPAY_CONFIG) # 传入对应支付方式配置 order_res= pay.trade_page_pay(order)# 传入对应订单
手机网站支付 [trade_wap_pay]
pay = Pay(ALIPAY_CONFIG) # 传入对应支付方式配置 order_res= pay.trade_wap_pay(order)# 传入对应订单
APP支付 [trade_app_pay]
pay = Pay(ALIPAY_CONFIG) # 传入对应支付方式配置 order_res= pay.trade_app_pay(order)# 传入对应订单
异步通知校验 [parse_and_verify_result]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应支付方式返回的原始数据,校验成功会返回解析成json数据 data = pay.parse_and_verify_result(req_xml)
微信JS支付 [trade_js_pay]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应订单 data = pay.trade_js_pay(order)
微信企业付款到零钱 [enterprise_pay]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应订单 data = pay.enterprise_pay(order)
交易查询 [trade_query]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应回单信息 data = pay.trade_query(response)
交易取消 [trade_cancel]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应回单信息 data = pay.trade_cancel(response)
退款 [trade_refund]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应回单信息 data = pay.trade_refund(response)
退款查询 [trade_refund_query]
# 传入对应支付方式配置 pay = Pay(WECHAT_CONFIG) # 传入对应回单信息 data = pay.trade_refund_query(response)
贡献指南
本项目目前支持的支付方式和API尚有限,欢迎提交Pull Request以扩展新的支付接口。同时,如有任何意见或建议,也欢迎提交Issue进行讨论。
声明:本项目的主要目标是支付整合,统一支付API和数据结构。在具体支付模块的接入实现中,参考了一些开源项目。
支付宝模块基于 python-alipay-sdk 开发。
微信模块基于 wx_pay_python 开发。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持本站。
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













