Skip to main content

[修复版] 微信支付 API v3 Python SDK(python sdk for wechatpay v3),fork from: https://github.com/minibear2021/wechatpayv3

Project description

【修复版 v1.2.36】微信支付 API v3 Python SDK

介绍

微信支付接口 V3 版 python 库。

适用对象

wechatpayv3同时支持微信支付直连模式服务商模式,接口说明详见官网。

特性

  1. 平台证书自动更新,无需开发者关注平台证书有效性,无需手动下载更新;
  2. 支持本地缓存平台证书,初始化时指定平台证书保存目录即可;
  3. 敏感信息直接传入明文参数,SDK 内部自动加密,无需手动处理;
  4. 回调通知自动验证回调消息,自动解密 resource 对象,并返回解密后的数据;
  5. 已适配直连模式服务商模式中除“电商收付通”以外所有 v3 版接口。

安装

$ pip install wechatpayv3-fix

使用方法

准备

参考微信官方文档准备好密钥, 证书文件和配置(证书/密钥/签名介绍)

  • 商户 API 证书私钥:PRIVATE_KEY。商户申请商户 API 证书时,会生成商户私钥,并保存在本地证书文件夹的文件 apiclient_key.pem 中。

    :warning: 不要把私钥文件暴露在公共场合,如上传到 Github,写在客户端代码等。

  • 商户 API 证书序列号:CERT_SERIAL_NO。每个证书都有一个由 CA 颁发的唯一编号,即证书序列号。扩展阅读 如何查看证书序列号
  • 微信支付 APIv3 密钥:APIV3_KEY,是在回调通知和微信支付平台证书下载接口中,为加强数据安全,对关键信息 AES-256-GCM 加密时使用的对称加密密钥。

一个最小的后端

examples.py 演示了一个带有Native 支付下单接口和支付通知接口的后端。 首先,修改 examplys.py 里以下几项配置参数:

# 微信支付商户号,服务商模式下为服务商户号,即官方文档中的sp_mchid。
MCHID = '1230000109'

# 商户证书私钥,此文件不要放置在下面设置的CERT_DIR目录里。
with open('path_to_key/apiclient_key.pem') as f:
    PRIVATE_KEY = f.read()

# 商户证书序列号
CERT_SERIAL_NO = '444F4864EA9B34415...'

# API v3密钥, https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay3_2.shtml
APIV3_KEY = 'MIIEvwIBADANBgkqhkiG9w0BAQE...'

# APPID,应用ID,服务商模式下为服务商应用ID,即官方文档中的sp_appid,也可以在调用接口的时候覆盖。
APPID = 'wxd678efh567hg6787'

# 回调地址,也可以在调用接口的时候覆盖。
NOTIFY_URL = 'https://www.xxxx.com/notify'

# 微信支付平台证书缓存目录,初始调试的时候可以设为None,首次使用确保此目录为空目录。
CERT_DIR = './cert'

# 日志记录器,记录web请求和回调细节,便于调试排错。
logging.basicConfig(filename=os.path.join(os.getcwd(), 'demo.log'), level=logging.DEBUG, filemode='a', format='%(asctime)s - %(process)s - %(levelname)s: %(message)s')
LOGGER = logging.getLogger("demo")

# 接入模式:False=直连商户模式,True=服务商模式。
PARTNER_MODE = False

# 代理设置,None或者{"https": "http://10.10.1.10:1080"},详细格式参见https://docs.python-requests.org/zh_CN/latest/user/advanced.html
PROXY = None

接下来初始化 WechatPay 实例并配置一个合适的接口:

wxpay = WeChatPay(
    wechatpay_type=WeChatPayType.NATIVE,
    mchid=MCHID,
    private_key=PRIVATE_KEY,
    cert_serial_no=CERT_SERIAL_NO,
    apiv3_key=APIV3_KEY,
    appid=APPID,
    notify_url=NOTIFY_URL,
    cert_dir=CERT_DIR,
    logger=LOGGER,
    partner_mode=PARTNER_MODE,
    proxy=PROXY)

app = Flask(__name__)

@app.route('/pay')
def pay():
    # 以native下单为例,下单成功后即可获取到'code_url',将'code_url'转换为二维码,并用微信扫码即可进行支付测试。
    out_trade_no = ''.join(sample(ascii_letters + digits, 8))
    description = 'demo-description'
    amount = 1
    code, message = wxpay.pay(
        description=description,
        out_trade_no=out_trade_no,
        amount={'total': amount},
        pay_type=WeChatPayType.NATIVE
    )
    return jsonify({'code': code, 'message': message})

检查一下参数无误,现在就可以用 python 解释器来运行:

$ python examples.py
 * Serving Flask app "examples" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

现在访问 http://127.0.0.1:5000/pay ,如果一切正常,你会看到下面一串 json 字符串:

{
  "code": 200,
  "message": "{\"code_url\":\"weixin://wxpay/bizpayurl?pr=abcdefghi\"}"
}

到这一步统一下单的后端就完成了,现在将 code_url 的值即"weixin://wxpay/bizpayurl?pr=abcdefghi"用草料转换为二维码即可用微信扫码进行支付测试。

以上步骤如果不能正确执行,务必仔细检查各项初始化参数,必要的情况下,登录微信支付后台,将所有参数重置。

Native 支付调试最简单便捷,调试通过没有问题证明初始化参数正确之后,如果需要采用其他(小程序、H5、JSAPI、APP)支付下单,可继续参考 examples.py。

接口清单

已适配的微信支付 V3 版 API 接口列表如下,部分接口调用示例可以参考这里

大类 小类 接口 接口函数 直连商户适用 服务商适用
公用 公用 调起支付签名 sign
公用 公用 回调通知 callback
公用 公用 敏感信息参数解密 decrypt
公用 公用 下载账单 download_bill
商户进件 特约商户进件、小微商户进件 提交申请单 applyment_submit
商户进件 特约商户进件、小微商户进件 查询申请单状态 applyment_query
商户进件 特约商户进件、小微商户进件 修改结算账号 applyment_settlement_modify
商户进件 特约商户进件、小微商户进件 查询结算账号 applyment_settlement_query
基础支付 JSAPI、APP、H5、Native、小程序支付 统一下单 pay
基础支付 JSAPI、APP、H5、Native、小程序支付 查询订单 query
基础支付 JSAPI、APP、H5、Native、小程序支付 关闭订单 close
基础支付 合单支付 统一下单 combine_pay
基础支付 合单支付 查询订单 combine_query
基础支付 合单支付 关闭订单 combine_close
基础支付 JSAPI、APP、H5、Native、小程序、合单支付 申请退款 refund
基础支付 JSAPI、APP、H5、Native、小程序、合单支付 查询单笔退款 query_refund
基础支付 JSAPI、APP、H5、Native、小程序、合单支付 申请交易账单 trade_bill
基础支付 JSAPI、APP、H5、Native、小程序、合单支付 申请资金账单 fundflow_bill
基础支付 JSAPI、APP、H5、Native、小程序、合单支付 申请单个子商户资金账单 submch_fundflow_bill
基础支付 JSAPI、APP、H5、Native、小程序、合单支付 下载账单 download_bill
经营能力 微信支付分(免确认模式) 创单结单合并 payscore_direct_complete
经营能力 微信支付分(免确认预授权模式) 商户预授权 payscore_permission
经营能力 微信支付分(免确认预授权模式) 查询用户授权记录 payscore_permission_query
经营能力 微信支付分(免确认预授权模式) 解除用户授权关系 payscore_permission_terminate
经营能力 微信支付分(公共 API) 创建支付分订单 payscore_create
经营能力 微信支付分(公共 API) 查询支付分订单 payscore_query
经营能力 微信支付分(公共 API) 取消支付分订单 payscore_cancel
经营能力 微信支付分(公共 API) 修改订单金额 payscore_modify
经营能力 微信支付分(公共 API) 完结支付分订单 payscore_complete
经营能力 微信支付分(公共 API) 商户发起催收扣款 payscore_pay
经营能力 微信支付分(公共 API) 同步服务订单信息 payscore_sync
经营能力 微信支付分(公共 API) 申请退款 payscore_refund
经营能力 微信支付分(公共 API) 查询单笔退款 payscore_refund_query
经营能力 微信支付分(公共 API) 商户申请获取对账单 payscore_merchant_bill
经营能力 支付即服务 服务人员注册 guides_register
经营能力 支付即服务 服务人员分配 guides_assign
经营能力 支付即服务 服务人员查询 guides_query
经营能力 支付即服务 服务人员信息更新 guides_update
经营能力 点金计划 点金计划管理 goldplan_plan_change
经营能力 点金计划 商家小票管理 goldplan_custompage_change
经营能力 点金计划 同业过滤标签管理 goldplan_advertising_filter
经营能力 点金计划 开通广告展示 goldplan_advertising_open
经营能力 点金计划 关闭广告展示 goldplan_advertising_close
行业方案 电商收付通 尚未适配 尚未适配
行业方案 智慧商圈 商圈积分同步 points_notify
行业方案 智慧商圈 商圈积分授权查询 user_authorization
行业方案 智慧商圈 商圈会员待积分状态查询 business_point_status
行业方案 智慧商圈 商圈会员停车状态同步 business_parking_sync
行业方案 微信支付分停车服务 查询车牌服务开通信息 parking_service_find
行业方案 微信支付分停车服务 创建停车入场 parking_enter
行业方案 微信支付分停车服务 扣费受理 parking_order
行业方案 微信支付分停车服务 查询订单 parking_query
营销工具 代金券 创建代金券批次 marketing_favor_stock_create
营销工具 代金券 激活代金券批次 marketing_favor_stock_start
营销工具 代金券 发放代金券批次 marketing_favor_stock_send
营销工具 代金券 暂停代金券批次 marketing_favor_stock_pause
营销工具 代金券 重启代金券批次 marketing_favor_stock_restart
营销工具 代金券 条件查询批次列表 marketing_favor_stock_list
营销工具 代金券 查询批次详情 marketing_favor_stock_detail
营销工具 代金券 查询代金券详情 marketing_favor_coupon_detail
营销工具 代金券 查询代金券可用商户 marketing_favor_stock_merchant
营销工具 代金券 查询代金券可用单品 marketing_favor_stock_item
营销工具 代金券 根据商户号查用户的券 marketing_favor_user_coupon
营销工具 代金券 下载批次核销明细 marketing_favor_use_flow
营销工具 代金券 下载批次退款明细 marketing_favor_refund_flow
营销工具 代金券 设置消息通知地址 marketing_favor_callback_update
营销工具 商家券 创建商家券 marketing_busifavor_stock_create
营销工具 商家券 查询商家券详情 marketing_busifavor_stock_query
营销工具 商家券 核销用户券 marketing_busifavor_coupon_use
营销工具 商家券 根据过滤条件查询用户券 marketing_busifavor_user_coupon
营销工具 商家券 查询用户单张券详情 marketing_busifavor_coupon_detail
营销工具 商家券 上传预存 code marketing_busifavor_couponcode_upload
营销工具 商家券 设置商家券事件通知地址 marketing_busifavor_callback_update
营销工具 商家券 查询商家券事件通知地址 marketing_busifavor_callback_query
营销工具 商家券 关联订单信息 marketing_busifavor_coupon_associate
营销工具 商家券 取消关联订单信息 marketing_busifavor_coupon_disassociate
营销工具 商家券 修改批次预算 marketing_busifavor_stock_budget
营销工具 商家券 修改商家券基本信息 marketing_busifavor_stock_modify
营销工具 商家券 申请退券 marketing_busifavor_coupon_return
营销工具 商家券 使券失效 marketing_busifavor_coupon_deactivate
营销工具 商家券 营销补差付款 marketing_busifavor_subsidy_pay
营销工具 商家券 查询营销补差付款单详情 marketing_busifavor_subsidy_query
营销工具 委托营销 建立合作关系 marketing_partnership_build
营销工具 委托营销 查询合作关系列表 marketing_partnership_query
营销工具 消费卡 发放消费卡 marketing_card_send
营销工具 支付有礼 创建全场满额送活动 marketing_paygift_activity_create
营销工具 支付有礼 查询活动详情接口 marketing_paygift_activity_detail
营销工具 支付有礼 查询活动发券商户号 marketing_paygift_merchants_list
营销工具 支付有礼 查询活动指定商品列表 marketing_paygift_goods_list
营销工具 支付有礼 终止活动 marketing_paygift_activity_terminate
营销工具 支付有礼 新增活动发券商户号 marketing_paygift_merchant_add
营销工具 支付有礼 获取支付有礼活动列表 marketing_paygift_activity_list
营销工具 支付有礼 删除活动发券商户号 marketing_paygift_merchant_delete
营销工具 银行定向活促 出行券切卡组件预下单 industry_coupon_token
营销工具 银行定向活促 导入定向用户协议号 bank_package_file
营销工具 图片上传 图片上传(营销专用) marketing_image_upload
资金应用 商家转账到零钱 发起商家转账 transfer_batch
资金应用 商家转账到零钱 微信批次单号查询批次单 transfer_query_batchid
资金应用 商家转账到零钱 微信明细单号查询明细单 transfer_query_detail_id
资金应用 商家转账到零钱 商家批次单号查询批次单 transfer_query_out_batch_no
资金应用 商家转账到零钱 商家明细单号查询明细单 transfer_query_out_detail_no
资金应用 商家转账到零钱 转账电子回单申请受理 transfer_bill_receipt
资金应用 商家转账到零钱 查询转账电子回单 transfer_query_bill_receipt
资金应用 商家转账到零钱 转账明细电子回单受理 transfer_detail_receipt
资金应用 商家转账到零钱 查询转账明细电子回单受理结果 transfer_query_receipt
资金应用 分账 请求分账 profitsharing_order
资金应用 分账 查询分账结果 profitsharing_order_query
资金应用 分账 请求分账回退 profitsharing_return
资金应用 分账 查询分账回退结果 profitsharing_return_query
资金应用 分账 解冻剩余资金 profitsharing_unfreeze
资金应用 分账 查询剩余待分金额 profitsharing_amount_query
资金应用 分账 查询最大分账比例 profitsharing_config_query
资金应用 分账 添加分账接收方 profitsharing_add_receiver
资金应用 分账 删除分账接收方 profitsharing_delete_receiver
资金应用 分账 申请分账账单 profitsharing_bill
资金应用 分账 下载账单 download_bill
资金应用 连锁品牌分账 请求分账 brand_profitsharing_order
资金应用 连锁品牌分账 查询分账结果 brand_profitsharing_order_query
资金应用 连锁品牌分账 请求分账回退 brand_profitsharing_return
资金应用 连锁品牌分账 查询分账回退结果 brand_profitsharing_return_query
资金应用 连锁品牌分账 完结分账 brand_profitsharing_unfreeze
资金应用 连锁品牌分账 查询剩余待分金额 brand_profitsharing_amount_query
资金应用 连锁品牌分账 查询最大分账比例 brand_profitsharing_config_query
资金应用 连锁品牌分账 添加分账接收方 brand_profitsharing_add_receiver
资金应用 连锁品牌分账 删除分账接收方 brand_profitsharing_delete_receiver
资金应用 连锁品牌分账 申请分账账单 profitsharing_bill
资金应用 连锁品牌分账 下载账单 download_bill
风险合规 商户开户意愿确认 提交申请单 apply4subject_submit
风险合规 商户开户意愿确认 撤销申请单 apply4subject_cancel
风险合规 商户开户意愿确认 查询申请单审核结果 apply4subject_query
风险合规 商户开户意愿确认 获取商户开户意愿确认状态 apply4subject_state
风险合规 消费者投诉 2.0 查询投诉单列表 complaint_list_query
风险合规 消费者投诉 2.0 查询投诉单详情 complaint_detail_query
风险合规 消费者投诉 2.0 查询投诉协商历史 complaint_history_query
风险合规 消费者投诉 2.0 创建投诉通知回调地址 complaint_notification_create
风险合规 消费者投诉 2.0 查询投诉通知回调地址 complaint_notification_query
风险合规 消费者投诉 2.0 更新投诉通知回调地址 complaint_notification_update
风险合规 消费者投诉 2.0 删除投诉通知回调地址 complaint_notification_delete
风险合规 消费者投诉 2.0 提交回复 complaint_response
风险合规 消费者投诉 2.0 反馈处理完成 complaint_complete
风险合规 消费者投诉 2.0 更新退款审批结果 complaint_update_refund
风险合规 消费者投诉 2.0 商户上传反馈图片 complaint_image_upload
风险合规 消费者投诉 2.0 图片下载 complaint_image_download
风险合规 商户违规通知回调 创建商户违规通知回调地址 merchantrisk_callback_create
风险合规 商户违规通知回调 查询商户违规通知回调地址 merchantrisk_callback_query
风险合规 商户违规通知回调 修改商户违规通知回调地址 merchantrisk_callback_update
风险合规 商户违规通知回调 删除商户违规通知回调地址 merchantrisk_callback_delete
其他能力 图片上传 图片上传 image_upload
其他能力 视频上传 视频上传 video_upload
其他 电子发票(公共API) 创建电子发票卡券模板 fapiao_card_template
其他 电子发票(公共API) 配置开发选项 fapiao_set_merchant_config
其他 电子发票(公共API) 查询商户配置的开发选项 fapiao_merchant_config
其他 电子发票(公共API) 获取抬头填写链接 fapiao_title_url
其他 电子发票(公共API) 获取用户填写的抬头 fapiao_title
其他 电子发票(区块链模式) 获取商品和服务税收分类对照表 fapiao_tax_codes
其他 电子发票(区块链模式) 获取商户开票基础信息 fapiao_merchant_base_info
其他 电子发票(区块链模式) 开具电子发票 fapiao_applications
其他 电子发票(区块链模式) 查询电子发票 fapiao_query
其他 电子发票(区块链模式) 冲红电子发票 fapiao_reverse
其他 电子发票(自建平台模式) 上传电子发票文件 fapiao_upload_file
其他 电子发票(自建平台模式) 将电子发票插入微信用户卡包 fapiao_insert_cards
其他 银行组件 获取对私银行卡号开户银行 capital_search_bank_number
其他 银行组件 查询支持个人业务的银行列表 capital_personal_banks
其他 银行组件 查询支持对公业务的银行列表 capital_corporate_banks
其他 银行组件 查询省份列表 capital_provinces
其他 银行组件 查询城市列表 capital_cities
其他 银行组件 查询支行列表 capital_branches

接口函数参数

参数类型对照参考下表:

微信支付官方文档声明 wechatpayv3 python sdk
string str
int int
object dict: {}
array list: []
boolean bool: True, False
message bytes

接口函数返回值

每个接口均同步返回 code 和 message,code 为 web 请求得到的 HTTP 状态码,message 为服务器返回的 json 字符串。 例外:

  1. 回调通知(callback)接口将收到的参数解密后返回,回调验证不合规或解密失败则返回 None;
  2. 下载账单(download_bill)和消费者投诉 2.0 的图片下载(complaint_image_download)接口返回的 message 为 bytes 类型,直接将 message 写入磁盘即可获得对应的目标文件。

常见问题

回调验证失败处理

开发者遇到的难点之一就是回调验证失败的问题,由于众多的 python web 框架对回调消息的处理不完全一致,如果出现回调验证失败,请务必确认传入的 headers 和 body 的值和类型。 通常框架传过来的 headers 类型是 dict,而 body 类型是 bytes。flask 框架参考以下方法可直接获取到解密后的实际内容。

@app.route('/notify', methods=['POST'])
def notify():
    result = wxpay.callback(request.headers, request.data)
    if result and result.get('event_type') == 'TRANSACTION.SUCCESS':
        resource = result.get('resource')
        appid = resource.get('appid')
        mchid = resource.get('mchid')
        out_trade_no = resource.get('out_trade_no')
        transaction_id = resource.get('transaction_id')
        trade_type = resource.get('trade_type')
        trade_state = resource.get('trade_state')
        trade_state_desc = resource.get('trade_state_desc')
        bank_type = resource.get('bank_type')
        attach = resource.get('attach')
        success_time = resource.get('success_time')
        payer = resource.get('payer')
        amount = resource.get('amount').get('total')
        # TODO: 根据返回参数进行必要的业务处理,处理完后返回200或204
        return jsonify({'code': 'SUCCESS', 'message': '成功'})
    else:
        return jsonify({'code': 'FAILED', 'message': '失败'}), 500

flask 框架

如上面示例,直接传入 request.headers 和 request.data 即可。

result = wxpay.callback(headers=request.headers, body=request.data)

django 框架

由于 django 框架特殊性,会将 headers 做一定的预处理,可以参考以下方式调用。

headers = {}
headers.update({'Wechatpay-Signature': request.META.get('HTTP_WECHATPAY_SIGNATURE')})
headers.update({'Wechatpay-Timestamp': request.META.get('HTTP_WECHATPAY_TIMESTAMP')})
headers.update({'Wechatpay-Nonce': request.META.get('HTTP_WECHATPAY_NONCE')})
headers.update({'Wechatpay-Serial': request.META.get('HTTP_WECHATPAY_SERIAL')})
result = wxpay.callback(headers=headers, body=request.body)

tornado 框架

直接传入 request.headers 和 request.body 即可。

result = wxpay.callback(headers=request.headers, body=request.body)

其他框架

参考以上处理方法,大原则就是保证传给 callback 的参数值和收到的值一致,不要转换为 dict,也不要转换为 string。

反复收到同一个回调消息怎么处理

实际开发中处理微信支付通知消息时有两个问题需要注意。一是可能会重复收到同一个通知消息,需要在代码中进行判断处理。另一个是处理消息的时间如果过长,建议考虑异步处理,先缓存消息,避免微信支付服务器端认为超时,如果持续超时,微信支付服务器端可能会认为回调消息接口不可用。

接口清单里怎么没有回调接口

所有的回调接口都通过公用接口 callback 处理,因此清单里没有一一罗列。对于收到的回调消息,可以通过 event_type 参数判断消息类型进行下一步处理,具体参数清单参考微信支付官方文档。

服务商模式如何接入

SDK 默认为直连商户接入,如果初始化时候指定 partner_mode=True,即切换为服务商模式。需要注意的是,一部分接口为直连商户专有,一部分接口为服务商模式专有,另有部分接口同时兼容直连商户和服务商,这些同时兼容的接口在两种模式下个别参数要求会稍有不同。

如何下载平台证书?

SDK 内部已经实现了自动下载和加载平台证书,无需预先下载。如需了解具体实现逻辑,可以参阅core.py中的_update_certificates 函数。

接口始终返回 500 错误

通常为初始化参数配置错误,如果反复检查无果,建议进入微信支付后台重置所有参数后再试。

回调接口始终校验失败

查阅 web 框架文档,确保传入 callback 的 body 参数没有经过任何转义,通常为 bytes 类型。

下载平台证书时解析失败

检查 APIV3_KEY 是否和微信支付后台设置的一致,如无法确认,建议重置后再试。

签名、验签、加密、解密的内部实现

一般应用开发者可以不用向下看了,有心了解这几项内部实现的可以参考这里了解。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wechatpayv3-fix-1.2.38.tar.gz (57.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page