Jeepay Python SDK 技术文档
1. 安装指南
1.1 环境要求
- Python 3.6 及以上版本
- 已安装 pip 包管理工具
1.2 安装方式
通过 pip 安装 Jeepay Python SDK:
pip install jeepay-python-sdk
或者从源码安装:
- 下载源码包
- 解压后进入项目目录
- 执行以下命令:
python setup.py install
2. 项目使用说明
2.1 初始化配置
在使用 SDK 前,需要先进行初始化配置:
import jeepay
from jeepay import AppConfig
# 设置请求超时时间(秒)
jeepay.request_timeout = 10
# 配置商户信息
AppConfig.set_mch_no("your_mch_no") # 商户号
AppConfig.set_app_id("your_app_id") # 应用ID
AppConfig.set_api_key("your_api_key") # API密钥
AppConfig.set_version("1.0") # API版本号
2.2 网络重试设置
# 设置最大重试次数
jeepay.max_network_retries = 1
# 设置是否重试
jeepay.bad_gateway_match = True
# 设置重试延迟时间(秒)
jeepay.network_retry_delay = 0.5
3. API 使用文档
3.1 支付相关 API
3.1.1 统一下单
response = jeepay.Pay.create(
mchOrderNo=f"mho{round(time.time() * 1000)}",
wayCode="ALI_BAR",
amount=1,
currency="cny",
clientIp="192.168.1.132",
subject="商品标题",
body="商品描述",
notifyUrl="https://your.domain.com/notify",
returnUrl="https://your.domain.com/return",
channelExtra='{"authCode":"281901870381096568"}',
extParam=""
)
3.1.2 订单查询
response = jeepay.Pay.pay_query(
payOrderId="P1747158206191792130"
# 或 mchOrderNo="your_order_no"
)
3.1.3 关闭订单
response = jeepay.Pay.pay_close(
payOrderId="P1747158206191792130"
# 或 mchOrderNo="your_order_no"
)
3.2 退款相关 API
3.2.1 发起退款
response = jeepay.Pay.refund(
payOrderId="P1747158206191792130",
mchRefundNo=f"mho{round(time.time() * 1000)}",
refundAmount=1,
currency="cny",
clientIp="192.168.1.132",
refundReason="测试退款",
notifyUrl="https://your.domain.com/refund_notify"
)
3.2.2 退款查询
response = jeepay.Pay.refund_query(
refundOrderId="R1747160237782626305"
# 或 mchRefundNo="your_refund_no"
)
3.3 转账相关 API
3.3.1 发起转账
response = jeepay.Transfer.create(
mchOrderNo=f"mho{round(time.time() * 1000)}",
amount=1,
currency="cny",
ifCode="aliaqfpay",
entryType="ALIPAY_CASH",
accountNo="15521548748",
accountName="测试",
transferDesc="测试转账",
clientIp="192.168.1.132",
notifyUrl="https://your.domain.com/transfer_notify"
)
3.3.2 转账查询
response = jeepay.Transfer.transfer_query(
transferId="T1743191690773204994"
# 或 mchOrderNo="your_transfer_no"
)
3.4 分账相关 API
3.4.1 绑定分账用户
response = jeepay.Division.bind_user(
ifCode="zftpay",
receiverAlias="15521254124",
receiverGroupId=100048,
accType=0,
accNo="15521254124",
relationType="PARTNER",
divisionProfit=0.3
)
3.4.2 发起订单分账
response = jeepay.Division.exec(
payOrderId="P1721732006052859906",
useSysAutoDivisionReceivers=0,
receivers='[{"receiverId":"800045"}]'
)
4. 项目安装方式
4.1 直接安装
推荐使用 pip 直接安装最新稳定版本:
pip install jeepay-python-sdk --upgrade
4.2 源码安装
如需从源码安装:
- 克隆仓库或下载源码包
- 进入项目目录
- 执行安装命令:
python setup.py install
4.3 验证安装
安装完成后,可以通过以下方式验证是否安装成功:
import jeepay
print(jeepay.__version__)
注意事项
- 所有金额参数单位为"分"
- 异步通知地址(notifyUrl)必须为可公开访问的URL
- 建议在生产环境设置合理的超时时间和重试机制
- 请妥善保管API密钥,避免泄露
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



