一、引言
在当今数字化的商业环境中,电子支付已经成为交易的主流方式。支付宝作为国内领先的第三方支付平台,被广泛应用于各类线上线下交易场景。对于 Python 开发者而言,如何方便快捷地在项目中对接支付宝支付是一个常见需求。本文将详细介绍如何使用 alipay
库中的 AliPay
类,完成支付宝支付的一系列操作,涵盖支付、查询、退款以及退款查询等功能。
二、准备工作
2.1 支付宝开放平台入驻与应用创建
- 访问支付宝开放平台,注册并登录账号。
- 入驻成为开发者后,创建一个新的应用。在应用管理界面,获取应用的
APPID
,这是应用在支付宝平台的唯一标识。
2.2 密钥生成与配置
- 生成 RSA2 密钥对(公钥和私钥),可以使用支付宝提供的密钥生成工具。
- 将应用私钥保存好,同时将公钥上传至支付宝开放平台。另外,需要获取支付宝公钥,用于验证支付宝返回的签名。
2.3 安装 alipay
库
使用 pip
命令安装 python-alipay-sdk
库,它提供了 AliPay
类来方便我们与支付宝进行交互:
pip install python-alipay-sdk --upgrade
三、导入 AliPay
并初始化
在 Python 代码中,我们需要导入 AliPay
类并进行初始化。以下是示例代码:
from alipay import AliPay
# 初始化 AliPay 对象
app_private_key_string = open("path/to/your/app_private_key.pem").read()
alipay_public_key_string = open("path/to/alipay_public_key.pem").read()
alipay = AliPay(
appid="your_appid",
app_notify_url=None, # 支付结果异步通知 URL,可根据实际情况设置
app_private_key_string=app_private_key_string,
alipay_public_key_string=alipay_public_key_string,
sign_type="RSA2", # 签名算法,推荐使用 RSA2
debug=False # 调试模式,True 表示使用沙箱环境,False 表示使用正式环境
)
四、发起支付请求
使用 AliPay
对象发起支付请求,生成支付链接或二维码。以下是电脑网站支付的示例代码:
# 支付参数
subject = "商品名称"
out_trade_no = "your_out_trade_no" # 商户订单号,需保证唯一
total_amount = 9.9 # 订单总金额
# 发起支付请求
order_string = alipay.api_alipay_trade_page_pay(
out_trade_no=out_trade_no,
total_amount=total_amount,
subject=subject,
return_url="your_return_url", # 支付成功后跳转的页面 URL
notify_url="your_notify_url" # 支付结果异步通知 URL
)
# 生成支付链接
pay_url = "https://openapi.alipay.com/gateway.do?" + order_string
print(f"支付链接:{pay_url}")
五、查询订单状态
在支付过程中,我们可能需要查询订单的支付状态。以下是查询订单的示例代码:
# 要查询的订单号
out_trade_no = "your_out_trade_no"
# 查询订单
result = alipay.api_alipay_trade_query(out_trade_no=out_trade_no)
if result.get("trade_status") == "TRADE_SUCCESS":
print("订单支付成功")
elif result.get("trade_status") == "TRADE_CLOSED":
print("订单已关闭")
else:
print(f"订单状态:{result.get('trade_status')}")
六、发起退款请求
如果需要对已支付的订单进行退款操作,可以使用以下代码:
# 要退款的订单号
out_trade_no = "your_out_trade_no"
# 退款金额
refund_amount = 9.9
# 退款原因
refund_reason = "用户申请退款"
# 发起退款请求
result = alipay.api_alipay_trade_refund(
out_trade_no=out_trade_no,
refund_amount=refund_amount,
refund_reason=refund_reason
)
if result.get("code") == "10000":
print("退款申请成功")
else:
print(f"退款申请失败,错误信息:{result.get('msg')}")
七、查询退款状态
发起退款请求后,我们可以查询退款的处理状态。以下是查询退款状态的示例代码:
# 要查询的订单号
out_trade_no = "your_out_trade_no"
# 退款单号(如果退款时未指定,可使用订单号代替)
out_request_no = "your_out_request_no"
# 查询退款状态
result = alipay.api_alipay_trade_fastpay_refund_query(
out_trade_no=out_trade_no,
out_request_no=out_request_no
)
if result.get("code") == "10000":
refund_status = result.get("refund_status")
print(f"退款状态:{refund_status}")
else:
print(f"退款查询失败,错误信息:{result.get('msg')}")
八、完整示例代码
from alipay import AliPay
# 初始化 AliPay 对象
app_private_key_string = open("path/to/your/app_private_key.pem").read()
alipay_public_key_string = open("path/to/alipay_public_key.pem").read()
alipay = AliPay(
appid="your_appid",
app_notify_url=None,
app_private_key_string=app_private_key_string,
alipay_public_key_string=alipay_public_key_string,
sign_type="RSA2",
debug=False
)
# 支付参数
subject = "商品名称"
out_trade_no = "your_out_trade_no"
total_amount = 9.9
# 发起支付请求
order_string = alipay.api_alipay_trade_page_pay(
out_trade_no=out_trade_no,
total_amount=total_amount,
subject=subject,
return_url="your_return_url",
notify_url="your_notify_url"
)
# 生成支付链接
pay_url = "https://openapi.alipay.com/gateway.do?" + order_string
print(f"支付链接:{pay_url}")
# 查询订单
result = alipay.api_alipay_trade_query(out_trade_no=out_trade_no)
if result.get("trade_status") == "TRADE_SUCCESS":
print("订单支付成功")
# 发起退款请求
refund_amount = 9.9
refund_reason = "用户申请退款"
refund_result = alipay.api_alipay_trade_refund(
out_trade_no=out_trade_no,
refund_amount=refund_amount,
refund_reason=refund_reason
)
if refund_result.get("code") == "10000":
print("退款申请成功")
# 查询退款状态
out_request_no = "your_out_request_no"
refund_query_result = alipay.api_alipay_trade_fastpay_refund_query(
out_trade_no=out_trade_no,
out_request_no=out_request_no
)
if refund_query_result.get("code") == "10000":
refund_status = refund_query_result.get("refund_status")
print(f"退款状态:{refund_status}")
else:
print(f"退款查询失败,错误信息:{refund_query_result.get('msg')}")
else:
print(f"退款申请失败,错误信息:{refund_result.get('msg')}")
else:
print(f"订单状态:{result.get('trade_status')}")
九、注意事项
- 密钥安全:应用私钥和支付宝公钥是非常重要的安全信息,务必妥善保管,避免泄露。
- 签名验证:在接收支付宝的异步通知时,需要对签名进行验证,确保数据的真实性和完整性。
- 订单号唯一性:商户订单号和退款单号在系统中必须保证唯一,避免出现重复订单或退款问题。
- 环境切换:在开发和测试阶段,可以将
debug
参数设置为True
,使用支付宝沙箱环境进行测试,确保正式上线前功能正常。
通过以上步骤,你可以使用 AliPay
类轻松实现支付宝支付的全流程操作,包括支付、查询、退款和退款查询。希望本文对你有所帮助!