Python 微信支付【下载电子回单】pdf凭证

背景

需求方提了一个需要下载微信支付的电子回单，下载【企业付款到零钱电子回单】的凭证。

原本调研看微信支付后台是否有批量下载电子回单的功能，找了一圈没找到。只找到了API接口。

微信支付接口文档

如何生成请求签名：https://pay.weixin.qq.com/docs/merchant/development/interface-rules/signature-generation.html

受理转账明细电子回单API：https://pay.weixin.qq.com/docs/merchant/apis/batch-transfer-to-balance/electronic-receipt-api/create-electronic-receipt.html

查询转账明细电子回单受理结果API：https://pay.weixin.qq.com/docs/merchant/apis/batch-transfer-to-balance/electronic-receipt-api/query-electronic-receipt.html

下载电子回单：https://pay.weixin.qq.com/docs/merchant/apis/batch-transfer-to-balance/download-receipt.html

实现思路

1. 根据【商户单号】去调用【受理转账明细电子回单API】
2. 基于【受理转账明细电子回单API】的结果得到【download_url】
3. 基于【download_url】去请求得到【文件流】

代码

import datetime
import io
import random
import string
from urllib.parse import urlparse, quote, urlencode, urlunparse

from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives.asymmetric import padding, rsa
from cryptography.hazmat.primitives import serialization
import base64

import requests
import json

# 证书路径
pem_path = '/path/apiclient_key.pem'
# 商户号
mchid = '16xxxxx2'
# 证书序列号
serial_no = '3Dxxxxxxxxxxxxxxxxxxxx83'

# 请求路径
base_url = "https://api.mch.weixin.qq.com"

def get_canonical_url(url):
    """
    获取绝对URL
    :param url: 
    :return: 
    """
    parsed_url = urlparse(url)
    
    # 获取路径并进行编码
    canonical_url = quote(parsed_url.path)

    # 如果有查询参数，添加到路径后面
    if parsed_url.query:
        canonical_url += "?" + parsed_url.query

    return canonical_url

def append_dict_to_url(url, params):
    """
    拼接URL和参数
    :param url: 
    :param params: 
    :return: 
    """
    # 解析 URL
    parsed_url = urlparse(url)

    # 将 dict 转换为查询参数字符串
    query_string = urlencode(params)

    # 创建新的 URL，包含原始的路径和新的查询参数
    new_url = urlunparse(parsed_url._replace(query=query_string))

    return new_url

def generate_random_string(length):
    """
    随机生成字符串
    :param length: 
    :return: 
    """
    # 选择字母和数字的组合
    characters = string.ascii_letters + string.digits
    # 随机选择字符并组合成字符串
    random_string = ''.join(random.choice(characters) for _ in range(length))
    return random_string

# print(generate_random_string(10))

def sign(message):
    """
    生成签名 参考：https://pay.weixin.qq.com/docs/merchant/development/interface-rules/signature-generation.html
    :param message: 
    :return: 
    """
    # 从 PEM 文件加载私钥
    with open(pem_path, "rb") as key_file:
        private_key = serialization.load_pem_private_key(
            key_file.read(),
            password=None,  # 如果私钥有密码，提供相应的密码
        )

    # 使用 SHA256 和 RSA 对消息进行签名
    signature = private_key.sign(
        message.encode('utf-8'),
        padding.PKCS1v15(),
        hashes.SHA256()
    )

    # 使用 Base64 编码签名
    signature_base64 = base64.b64encode(signature).decode('utf-8')
    return signature_base64

def build_message(method, url, timestamp, nonce_str, body):
    """
    生成【请求签名串】参考：https://pay.weixin.qq.com/docs/merchant/development/interface-rules/signature-generation.html
    :param method: 获取HTTP请求的方法（GET，POST，PUT）
    :param url: 获取请求的绝对URL，并去除域名部分得到参与签名的URL。如果请求中有查询参数，URL末尾应附加有'?'和对应的查询字符串。
    :param timestamp: 获取发起请求时的系统当前时间戳(秒)
    :param nonce_str: 随机串
    :param body: 获取请求中的请求报文主体，请求方法为GET时，报文主体为空，当请求方法为POST或PUT时，请使用真实发送的JSON报文。 图片上传API，请使用meta对应的JSON报文
    :return:
    """
    if method == 'GET' or body is None:
        body = ''
    url_encode = get_canonical_url(url)
    return f'{method}\n{url_encode}\n{timestamp}\n{nonce_str}\n{body}\n'

def get_token(method, url, body):
    """
    生成token 参考：https://pay.weixin.qq.com/docs/merchant/development/interface-rules/signature-generation.html
    :param method: HTTP请求的方法（GET，POST，PUT）
    :param url: 获取请求的绝对URL，并去除域名部分得到参与签名的URL。如果请求中有查询参数，URL末尾应附加有'?'和对应的查询字符串
    :param body: 获取请求中的请求报文主体,
    :return:
    """
    # 签名算法
    schema = "WECHATPAY2-SHA256-RSA2048"
    nonce_str = generate_random_string(10)
    timestamp = int(datetime.datetime.now().timestamp())

    # 签名
    signature = sign(build_message(method, url, timestamp, nonce_str, body))
    return f'{schema} mchid="{mchid}",nonce_str="{nonce_str}",timestamp="{timestamp}",serial_no="{serial_no}",signature="{signature}"'


# 受理转账明细电子回单API
def apply_transfer_detail(out_detail_no):
    url = f"{base_url}/v3/transfer-detail/electronic-receipts"

    # out_detail_no 【商家转账明细单号】 该单号为商户申请转账时生成的商家转账明细单号。
    # 1.受理类型为BATCH_TRANSFER时填写商家批量转账明细单号。
    # 2. 受理类型为TRANSFER_TO_POCKET或TRANSFER_TO_BANK时填写商家转账单号。
    data = {
        "accept_type": 'TRANSFER_TO_POCKET',
        "out_detail_no": out_detail_no
    }

    # 获取token
    access_token = get_token('POST', url, json.dumps(data))

    header = {
        'Authorization': access_token,
        'Accept': 'application/json',
        'Content-Type': 'application/json'
    }
    response = requests.post(url, headers=header, data=json.dumps(data))
    return response.json()

# 查询转账明细电子回单受理结果
def query_transfer_detail(out_detail_no):
    url = f"{base_url}/v3/transfer-detail/electronic-receipts"
    
    data = {
        "accept_type": 'TRANSFER_TO_POCKET',
        "out_detail_no": out_detail_no
    }
    
    # 获取token
    access_token = get_token('GET', append_dict_to_url(url, data), '')

    header = {
        'Authorization': access_token,
        'Accept': 'application/json'
    }
    response = requests.get(append_dict_to_url(url, data), headers=header)
    return response.json()


# 申请电子回单凭证
print(apply_transfer_detail('T2024081318442184426'))

# 查询已申请的电子回单凭证
print(query_transfer_detail('T2024081318442184426'))


def download(url, file_path):
	"""
    下载文件
    :param url:
    :param file_name:
    :return:
    """
    access_token = get_token('GET', url, '')

    header = {
        'Authorization': access_token
    }

    response = requests.get(url, headers=header)
    if response.status_code == 200:
        # 使用 io.BytesIO 读取流
        pdf_file = io.BytesIO(response.content)
        print(response.headers)

        # 将 PDF 流保存为本地文件
        with open(file_path, 'wb') as f:
            f.write(pdf_file.getbuffer())

        print("PDF 文件已保存")
    else:
        print("无法下载 PDF 文件")

# 下载电子回单
 download_url = 'https://api.mch.weixin.qq.com/v3/transferdownload/elecvoucherfile?token=xxxxxx'
 download(download_url, '/path/file.pdf')