epusdt 0.2.8

Epusdt 商户支付 Python SDK，支持同步/异步客户端、GMPay、EPay 兼容接入与回调验签

epusdt Python SDK

适用于 GMWalletApp/epusdt 商户公开支付接口的 Python SDK，提供同步与异步两套客户端，覆盖 GMPay 下单、EPay submit.php 兼容接入、订单查询、回调验签和收款二维码生成。

当前版本只封装商户公开支付能力，不包含后台管理接口。

相关链接

• Epusdt 官方项目：GMWalletApp/epusdt
• PyPI 页面：epusdt
• 更新日志：CHANGELOG.md
• 示例代码：同步基础用法 / 异步基础用法 / Flask / FastAPI / Django

核心能力

• GMPay 创建订单
• 支付配置查询
• 收银台订单查询
• 支付状态查询
• 切换网络 / 币种
• 手动提交交易哈希补单
• EPay submit.php 兼容接入
• GMPay / EPay 回调验签
• 订单二维码生成
• 官方 status_code 业务错误码映射
• Django / Flask / FastAPI 接入示例

官方支持矩阵

以下内容依据 GMWalletApp/epusdt 当前官方源码中的默认链配置、默认币种种子和支付监听 / 校验逻辑整理，不以单个网关实例配置为准。

默认启用网络：

• Tron
• Ethereum
• Solana
• BSC
• Polygon
• Plasma
• TON
• Aptos

官方默认内置币种：

• Tron：USDT、TRX
• Ethereum：USDT、USDC
• Solana：USDT、USDC、SOL
• BSC：USDT、USDC
• Polygon：USDT、USDC、USDC.e
• Plasma：USDT
• TON：TON、USDT
• Aptos：USDC、USDT

补充说明：

• 官方支持按网络新增自定义代币；只要后台已经配置，SDK 可以直接传字符串，例如 token="MOVEUSD"。
• GRAM 当前不属于官方默认支持币种，官方测试中会返回 SupportedAssetNotFound。
• 本 README 不宣称 Arbitrum、Base、X-Layer、原生 ETH、原生 BNB 已支持，因为这次未在官方当前源码中确认到对应公开支付实现。

客户端选择

• EpusdtClient：适合同步 Web 项目、普通脚本、管理后台任务
• AsyncEpusdtClient：适合 FastAPI、异步任务队列、高并发接口服务

安装

直接安装：

pip install epusdt

需要二维码功能：

pip install epusdt[qrcode]

升级到最新版：

pip install --upgrade epusdt

内置枚举

SDK 内置了一组和官方默认支持矩阵对应的常用枚举：

• Network：TRON、SOLANA、ETHEREUM、BSC、POLYGON、PLASMA、TON、APTOS
• Token：USDT、USDC、USDC_E、TRX、SOL、TON

如果你的网关后台新增了自定义代币，不需要等待 SDK 发版，直接传原始字符串即可。

快速开始

同步客户端

from epusdt import EpusdtClient, Network, Token

with EpusdtClient(
    base_url="https://pay.example.com",
    pid="1000",
    secret_key="epusdt_secret_key",
) as client:
    order = client.create_order(
        order_id="ORD202606240001",
        amount=100,
        currency="cny",
        token=Token.USDT,
        network=Network.TRON,
        notify_url="https://merchant.example.com/notify",
        redirect_url="https://merchant.example.com/return",
        name="会员充值",
    )

    print(order.trade_id)
    print(order.payment_url)
    print(order.actual_amount)

异步客户端

import asyncio

from epusdt import AsyncEpusdtClient, Network, Token


async def main() -> None:
    async with AsyncEpusdtClient(
        base_url="https://pay.example.com",
        pid="1000",
        secret_key="epusdt_secret_key",
    ) as client:
        order = await client.create_order(
            order_id="ORD202606240099",
            amount=100,
            currency="cny",
            token=Token.USDT,
            network=Network.TRON,
            notify_url="https://merchant.example.com/notify",
            redirect_url="https://merchant.example.com/return",
            name="会员充值",
        )

        print(order.trade_id)
        print(order.payment_url)


asyncio.run(main())

常见用法

以下示例默认已经初始化好 client。如果你使用异步客户端，对应方法前加 await 即可。

查询支付配置

config = client.get_public_config()

for asset in config.supported_assets:
    print(asset.network, asset.tokens)

创建待选网络订单

placeholder = client.create_order(
    order_id="ORD202606240002",
    amount=88.5,
    currency="cny",
    notify_url="https://merchant.example.com/notify",
)

selected = client.switch_network(
    trade_id=placeholder.trade_id,
    token="USDT",
    network="solana",
)

print(selected.trade_id)
print(selected.receive_address)

查询订单和支付状态

checkout = client.get_checkout("20260523171652123456001")
status = client.check_status("20260523171652123456001")

print(checkout.payment_type)
print(status.status)

EPay 兼容接入

构造跳转地址：

url = client.build_epay_redirect_url(
    out_trade_no="ORD202606240003",
    money=100,
    notify_url="https://merchant.example.com/notify",
    return_url="https://merchant.example.com/return",
    name="会员充值",
)

print(url)

直接请求网关并获取收银台地址：

redirect = client.create_epay_order(
    out_trade_no="ORD202606240003",
    money=100,
    notify_url="https://merchant.example.com/notify",
    return_url="https://merchant.example.com/return",
)

print(redirect.checkout_url)

手动补单

result = client.submit_tx_hash(
    trade_id="20260523171652123456001",
    block_transaction_id="0xabc123",
)

print(result.status)
print(result.block_transaction_id)

回调验签

GMPay JSON 回调：

payload = {
    "pid": "1000",
    "trade_id": "20260523171652123456001",
    "order_id": "ORD202605230001",
    "amount": 100,
    "actual_amount": 14.29,
    "receive_address": "TTestTronAddress001",
    "token": "USDT",
    "block_transaction_id": "0xabc123",
    "status": 2,
    "signature": "a1b2c3",
}

callback = client.parse_gmpay_callback(payload)
print(callback.trade_id)

EPay GET 回调：

params = {
    "pid": "1000",
    "trade_no": "20260523171652123456001",
    "out_trade_no": "ORD202605230001",
    "type": "alipay",
    "name": "会员充值",
    "money": "100.0000",
    "trade_status": "TRADE_SUCCESS",
    "sign": "a1b2c3",
    "sign_type": "MD5",
}

callback = client.parse_epay_callback(params)
print(callback.out_trade_no)

业务错误码捕获

SDK 已按官方 status_code 映射常见业务异常，商户侧可以直接按具体错误类型处理：

from epusdt import (
    EpusdtClient,
    InvalidNotifyURLError,
    OrderExistsError,
    OrderNotFoundError,
)

client = EpusdtClient(
    base_url="https://pay.example.com",
    pid="1000",
    secret_key="epusdt_secret_key",
)

try:
    client.create_order(
        order_id="ORD202606240003",
        amount=100,
        currency="cny",
        notify_url="https://merchant.example.com/notify",
    )
except OrderExistsError:
    print("订单号重复")
except InvalidNotifyURLError:
    print("回调地址不合法")
except OrderNotFoundError:
    print("订单不存在")

生成二维码

order = client.get_checkout("20260523171652123456001")

image = order.generate_qrcode()
image.save("epusdt-payment.png")

Web 项目示例

• examples/flask_example.py：同步 Flask 接入示例
• examples/fastapi_example.py：异步 FastAPI 接入示例
• examples/django_example.py：Django 下单、GMPay 回调、EPay 回调完整模板
• examples/live_gateway_check.py：真实网关联调脚本，可串行检查配置、下单、切网和查单

自动化流程

仓库内已提供 GitHub Actions：

• CI：自动运行多 Python 版本测试、构建和 twine check
• Release：手动触发发布，自动测试、构建、创建 GitHub Release，并可上传到 PyPI

发布到 PyPI 前，需要在 GitHub 仓库 Secrets and variables / Actions 中配置：

• PYPI_API_TOKEN

API 一览

• EpusdtClient(...)
• AsyncEpusdtClient(...)
• create_order(...)
• get_public_config()
• get_checkout(trade_id)
• check_status(trade_id)
• switch_network(trade_id, token, network)
• submit_tx_hash(trade_id, block_transaction_id)
• build_epay_params(...)
• build_epay_redirect_url(...)
• create_epay_order(...)
• verify_gmpay_callback(payload)
• verify_epay_callback(params)
• parse_gmpay_callback(payload)
• parse_epay_callback(params)

适用范围

当前版本面向 epusdt 商户公开支付接口，适合以下接入场景：

• 服务端创建订单
• 前端收银台支付
• EPay 兼容接入
• 支付回调验签
• Flask / Django 等同步项目
• FastAPI / 异步任务队列项目

验证情况

• 单元测试通过
• 构建通过
• 干净虚拟环境安装通过
• 安装后导入通过
• 二维码功能烟测通过
• 同步与异步客户端都已覆盖测试

参与开发

本地开发、测试和构建说明见 CONTRIBUTING.md。