Skip to content

Latest commit

 

History

History
391 lines (319 loc) · 13.4 KB

README.zh-hans.md

File metadata and controls

391 lines (319 loc) · 13.4 KB

python-alipay-sdk

PyPI version codecov travis-ci

支付宝Python SDK

支付宝没有提供Python SDK。生成预付订单需要使用SHA1withRSA签名，签名的生成比较麻烦容易出错。这里提供了一个简单的库，希望能够简化一些Python开发的流程。

自1.0开始，我们不再支持旧版的接口，比如即时到帐（你可以选择使用0.6.*版本的python-alipay-sdk或者使用电脑网站支付接口）。

我们支持的所有支付方式，其签名类型必须为RSA或者RSA2。目前实现了以下功能：

关于签名的详细实现细节参看这篇教程. 如果你不希望深入了解技术实现的细节，你可以直接阅读下面的使用教程。

使用教程

安装

# 安装python-alipay-sdk
pip install python-alipay-sdk --upgrade

生成密钥文件

openssl
OpenSSL> genrsa -out app_private_key.pem   2048  # 私钥
OpenSSL> rsa -in app_private_key.pem -pubout -out app_public_key.pem # 导出公钥
OpenSSL> exit

在支付宝上下载的公钥是一个字符串，你需要在文本的首尾添加标记位 (-----BEGIN PUBLIC KEY-----和-----END PUBLIC KEY-----) 才能正常使用 证书的格式你可以参考这里

初始化

    from alipay import AliPay, ISVAlipay

    app_private_key_string = open("/path/to/your/private/key.pem").read()
    alipay_public_key_string = open("/path/to/alipay/public/key.pem").read()

    app_private_key_string == """
        -----BEGIN RSA PRIVATE KEY-----
        base64 encoded content
        -----END RSA PRIVATE KEY-----
        """

    alipay_public_key_string == """
        -----BEGIN PUBLIC KEY-----
        base64 encoded content
        -----END PUBLIC KEY-----
    """

    alipay = AliPay(
      appid="",
      app_notify_url=None,  # 默认回调url
      app_private_key_string=app_private_key_string,
      alipay_public_key_string=alipay_public_key_string,  # 支付宝的公钥，验证支付宝回传消息使用，不是你自己的公钥,
      sign_type="RSA" # RSA 或者 RSA2
      debug=False  # 默认False
    )


    # If you don't know what ISV is, then forget about what I mentioned below
    # either app_auth_code or app_auth_token should not be None
    isv_alipay = ISVAliPay(
      appid="",
      app_notify_url=None,  # 默认回调url
      app_private_key_srting="", 
      alipay_public_key_string="", # alipay public key, do not use your public key!
      sign_type="RSA" # RSA or RSA2
      debug=False  # False by default,
      app_auth_code=None, 
      app_auth_token=None
    )

接口基本命名规则

对于一个支付宝的接口，比如alipay.trade.page.pay，则一般可以这么调用接口：alipay.api_alipay_trade_page_pay(). 也就是说，我们做了这么一个转换:

 内部函数名 =  alipay_ + 支付宝接口名.replace(".", "_")

支付宝对于请求的biz_content,里面有一些参数必选，有一些可选。对于必选的参数，他们一般被明确定义在函数的参数里面。对于可选参数，他们一般被放在kwargs里面,然后被添加到biz_content里面去。比如alipay.trade.page.pay可以这么调用:

alipay.api_alipay_trade_page_pay(
    subject="测试订单", 
    out_trade_no="2017020101", 
    total_amount=100
)

也可以这么调用：

alipay.api_alipay_trade_page_pay(
    subject="测试订单", 
    out_trade_no="2017020101", 
    total_amount=100,
    goods_type=0,  # 可选
    timeout_express="90m"  # 可选
    ...
)

电脑网站支付 alipay.trade.page.pay

    # 如果你是Python 2用户（考虑考虑升级到Python 3吧），请确保非ascii的字符串为utf8编码：
    subject = u"测试订单".encode("utf8")
    # 如果你是 Python 3的用户，使用默认的字符串即可
    subject = "测试订单"

    # 电脑网站支付，需要跳转到https://openapi.alipay.com/gateway.do? + order_string
    order_string = alipay.api_alipay_trade_page_pay(
        out_trade_no="20161112",
        total_amount=0.01,
        subject=subject,
        return_url="https://example.com",
        notify_url="https://example.com/notify" # 可选, 不填则使用默认notify url
    )

手机网站支付 alipay.trade.wap.pay

    # 手机网站支付，需要跳转到https://openapi.alipay.com/gateway.do? + order_string
    order_string = alipay.api_alipay_trade_wap_pay(
        out_trade_no="20161112",
        total_amount=0.01,
        subject=subject,
        return_url="https://example.com",
        notify_url="https://example.com/notify" # 可选, 不填则使用默认notify url
    )

App支付 alipay.trade.app.pay

    # App支付，将order_string返回给app即可
    order_string = alipay.api_alipay_trade_app_pay(
        out_trade_no="20161112",
        total_amount=0.01,
        subject=subject,
        notify_url="https://example.com/notify" # 可选, 不填则使用默认notify url
    )

通知验证

这里有一个简单的基于flask的验证：

from flask import Flask
from flask import request
app = Flask(__name__)

@app.route('/', methods=["GET", "POST"])
def hello_world():
    data = request.form.to_dict()
    signature = data.pop("sign")

    print(json.dumps(data))
    print(signature)

    # verify 
    success = alipay.verify(data, signature)
    if success and data["trade_status"] in ("TRADE_SUCCESS", "TRADE_FINISHED" ):
        print("trade succeed")

一般而言，可以这样验证回调通知

    # 验证alipay的异步通知，data来自支付宝回调POST 给你的data，字典格式.
    data = {
          "subject": "测试订单",
          "gmt_payment": "2016-11-16 11:42:19",
          "charset": "utf-8",
          "seller_id": "xxxx",
          "trade_status": "TRADE_SUCCESS",
          "buyer_id": "xxxx",
          "auth_app_id": "xxxx",
          "buyer_pay_amount": "0.01",
          "version": "1.0",
          "gmt_create": "2016-11-16 11:42:18",
          "trade_no": "xxxx",
          "fund_bill_list": "[{\"amount\":\"0.01\",\"fundChannel\":\"ALIPAYACCOUNT\"}]",
          "app_id": "xxxx",
          "notify_time": "2016-11-16 11:42:19",
          "point_amount": "0.00",
          "total_amount": "0.01",
          "notify_type": "trade_status_sync",
          "out_trade_no": "xxxx",
          "buyer_logon_id": "xxxx",
          "notify_id": "xxxx",
          "seller_email": "xxxx",
          "receipt_amount": "0.01",
          "invoice_amount": "0.01",
          "sign": "xxx"
        }
    signature = data.pop("sign")
    success = alipay.verify(data, signature)
    if success and data["trade_status"] in ("TRADE_SUCCESS", "TRADE_FINISHED" ):
        print("trade succeed")

当面付(条码支付) alipay.trade.pay

以下是一个当面付的基本例子

alipay = AliPay(appid="", ...)

result = alipay.api_alipay_trade_pay(
    out_trade_no="out_trade_no", 
    scene="bar_code/wave_code",
    auth_code="auth_code", 
    subject="subject",
    discountable_amount=10,
    total_amount=20,
    notify_url="https://example.com/notify" # 可选, 不填则使用默认notify url
    )

if  result["code"] == "10000":
    print("Order is paid")

交易预创建(扫码支付) alipay.trade.precreate

alipay = AliPay(appid="", ...)

# create an order
alipay.api_alipay_trade_precreate    (
    subject="test subject",
    out_trade_no="out_trade_no",
    total_amount=100
)

# check order status
paid = False
for i in range(10):
    # check every 3s, and 10 times in all
    print("now sleep 3s")
    time.sleep(3)
    result = alipay.api_alipay_trade_query(out_trade_no="out_trade_no")
    if result.get("trade_status", "") == "TRADE_SUCCESS":
        paid = True
        break
    print("not paid...")

# order is not paid in 30s , cancel this order
if paid is False:
    alipay.api_alipay_trade_cancel(out_trade_no=out_trade_no)

退款 alipay.trade.refund

refund 需要传入的参数参见官方文档

result = alipay.api_alipay_trade_refund(out_trade_no="xxx", refund_amount="xxx", ...)

if result["code"] == "10000":
    print("success")

统一退款查询alipay.trade.fastpay.refund.query

result = alipay.api_alipay_trade_fastpay_refund_query("20171120", out_trade_no="20171120")

result = {
    'code': '10000', 
    'msg': 'Success', 
    'out_request_no': '20171120', 
    'out_trade_no': '20171120', 
    'refund_amount': '20.00', 
    'total_amount': '20.00', 
    'trade_no': '2017112021001004070200297107'
}

单笔转账到支付宝账户接口 alipay.fund.trans.toaccount.transfer

    # transfer money to alipay account
    result = alipay.api_alipay_fund_trans_toaccount_transfer(
        datetime.now().strftime("%Y%m%d%H%M%S"),
        payee_type="ALIPAY_LOGONID/ALIPAY_USERID",
        payee_account="csqnji8117@sandbox.com",
        amount=3.12
    )
    result = {'code': '10000', 'msg': 'Success', 'order_id': '', 'out_biz_no': '', 'pay_date': '2017-06-26 14:36:25'}

查询转账订单接口 alipay.fund.trans.order.query

   result = alipay.api_alipay_fund_trans_order_query(
        out_biz_no="20170626152216"
    )
    print(result)

ISV 集成

在开始前，请务必阅读官方文档

生成app_auth_code 

    isv_alipay = ISVAliPay(
        ...
        app_auth_code="app_auth_code" 
    )

    response = isv_alipay.api_alipay_open_auth_token_app()
    response = {
      "code": "10000",
      "msg": "Success",
      "app_auth_token": "201708xxx",
      "app_refresh_token": "201708xxx",
      "auth_app_id": "appid",
      "expires_in": 31536000,
      "re_expires_in": 32140800,
      "user_id": "2088xxxxx
    }

查询授权产品 

    response = alipay_open_auth_token_app_query()

测试

python -m unittest discover

或者你可以传入debug=True, 进行手动测试

alipay = AliPay(..., debug=True)

Changelog

2018-03-16(version 1.7)

  • 使用pycryptodomex进行底层加解密运算，避免和旧的加密库冲突(感谢fakepoet)

2018-01-23(version 1.6)

  • 支持传入密钥字符串初始化Alipay对象

2017-12-04(version 1.5.1)

  • bug fix for ISVAlipay.build_body.

2017-11-20(version 1.5)

  • alipay.trade.fastpay.refund.query 统一收单交易退款查询

2017-11-14(version 1.4.1)

  • 修复忘记将notify url 传入api_alipay_trade_precreate的bug.

2017-10-20(version 1.4.0)

  • 将加密库依赖更新到pycryptodome，旧版用户请卸载pycrypto后安装使用.

2017-08-21(version 1.3.0)

alipay.trade.wap.pay alipay_trade_app_pay alipay.trade.page.pay alipay.trade.pay

2017-08-07(version 1.2.0)

  • 四个支付函数可以额外传入notify_url

2017-08-07(version 1.2.0)

  • ISV 授权等功能

2017-06-25(version 1.1.0)

  • alipay.fund.trans.toaccount.transfer 以及 alipay.fund.trans.order.query

2017-05-28(version 1.0.1)

  • alipay.trade.page.pay里面return_url没有被传入

2017-05-26 (version 1.0)

  • 后台全部重构，对各种接口重命名。
  • 使用新版的电脑网站支付接口，不再支持即时到帐接口
  • 将key重文件读出后放到内存，避免每次签名都需要访问文件。