ipaynow-python-sdk 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ipaynow_python_sdk-1.0.0.dist-info/METADATA +196 -0
- ipaynow_python_sdk-1.0.0.dist-info/RECORD +15 -0
- ipaynow_python_sdk-1.0.0.dist-info/WHEEL +5 -0
- ipaynow_python_sdk-1.0.0.dist-info/top_level.txt +1 -0
- ipaynow_sdk/__init__.py +93 -0
- ipaynow_sdk/client.py +78 -0
- ipaynow_sdk/config.py +78 -0
- ipaynow_sdk/errors.py +31 -0
- ipaynow_sdk/notify.py +44 -0
- ipaynow_sdk/params.py +195 -0
- ipaynow_sdk/parser.py +17 -0
- ipaynow_sdk/requests.py +149 -0
- ipaynow_sdk/responses.py +107 -0
- ipaynow_sdk/signer.py +94 -0
- ipaynow_sdk/transport.py +63 -0
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ipaynow-python-sdk
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: 现在支付(iPayNow)Python SDK:统一下单、订单查询、退款、撤销、回调验签。
|
|
5
|
+
Author-email: iPayNow <jishuzhichi@ipaynow.cn>
|
|
6
|
+
License: Proprietary
|
|
7
|
+
Project-URL: Homepage, https://www.ipaynow.cn
|
|
8
|
+
Project-URL: Repository, https://github.com/ipaynow/ipaynow-sdk
|
|
9
|
+
Requires-Python: >=3.9
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
Requires-Dist: cryptography<46,>=45
|
|
12
|
+
|
|
13
|
+
# iPayNow Python SDK
|
|
14
|
+
|
|
15
|
+
现在支付 Python SDK,封装统一下单、订单查询、退款、撤销、回调验签,零运行时依赖(仅使用标准库)。
|
|
16
|
+
|
|
17
|
+
## 环境要求
|
|
18
|
+
|
|
19
|
+
- Python 3.9+
|
|
20
|
+
|
|
21
|
+
## 安装方式
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pip install ipaynow-python-sdk
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
包名为 `ipaynow-python-sdk`,导入名为 `ipaynow_sdk`。
|
|
28
|
+
|
|
29
|
+
## 快速开始
|
|
30
|
+
|
|
31
|
+
```python
|
|
32
|
+
from ipaynow_sdk import (
|
|
33
|
+
IpaynowClient,
|
|
34
|
+
IpaynowConfig,
|
|
35
|
+
H5UnifiedOrderParams,
|
|
36
|
+
H5UnifiedOrderRequest,
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
client = IpaynowClient(IpaynowConfig("appId", "appKey", "https://pay.ipaynow.cn"))
|
|
40
|
+
|
|
41
|
+
params = H5UnifiedOrderParams(
|
|
42
|
+
mhtOrderNo="ORDER202607030001",
|
|
43
|
+
mhtOrderName="测试订单",
|
|
44
|
+
mhtOrderDetail="测试订单",
|
|
45
|
+
mhtOrderAmt=1,
|
|
46
|
+
mhtOrderTimeOut=120,
|
|
47
|
+
mhtOrderStartTime="20260703120000",
|
|
48
|
+
notifyUrl="https://example.com/notify",
|
|
49
|
+
frontNotifyUrl="https://example.com/front",
|
|
50
|
+
payChannelType="12",
|
|
51
|
+
outputType="1",
|
|
52
|
+
consumerCreateIp="127.0.0.1",
|
|
53
|
+
)
|
|
54
|
+
|
|
55
|
+
response = client.execute(H5UnifiedOrderRequest(params))
|
|
56
|
+
if response.is_success():
|
|
57
|
+
tn = response.tn()
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## 前端 Form 表单提交
|
|
61
|
+
|
|
62
|
+
需要让浏览器直接向现在支付网关提交表单时,使用 `build_form_fields` 生成完整请求字段。入参与 `execute` 一致,SDK 不发起 HTTP 请求。
|
|
63
|
+
|
|
64
|
+
```python
|
|
65
|
+
fields = client.build_form_fields(H5UnifiedOrderRequest(params))
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
返回字段包含业务参数、公共参数和签名字段,例如:
|
|
69
|
+
|
|
70
|
+
- `funcode`
|
|
71
|
+
- `version`
|
|
72
|
+
- `appId`
|
|
73
|
+
- `mhtCharset`
|
|
74
|
+
- `mhtSignType` 或 `signType`
|
|
75
|
+
- `mhtSignature`
|
|
76
|
+
|
|
77
|
+
表单提交地址由请求路径决定:
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
action = client.config.endpoint(H5UnifiedOrderRequest(params).path)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## 支持接口
|
|
84
|
+
|
|
85
|
+
- `WP001`:统一下单(JSAPI / 聚合码 / 小程序 / H5 / APP)
|
|
86
|
+
- `MQ002`:订单查询
|
|
87
|
+
- `N001`:支付结果回调
|
|
88
|
+
- `R001`:退款
|
|
89
|
+
- `Q001`:退款查询
|
|
90
|
+
- `RN001`:退款结果回调
|
|
91
|
+
- `R002`:撤销
|
|
92
|
+
- `Q002`:撤销查询
|
|
93
|
+
|
|
94
|
+
对应的 Params/Request/Response 类型:
|
|
95
|
+
|
|
96
|
+
| 场景 | Params | Request | Response |
|
|
97
|
+
| --- | --- | --- | --- |
|
|
98
|
+
| JSAPI 下单 | `JsapiUnifiedOrderParams` | `JsapiUnifiedOrderRequest` | `JsapiUnifiedOrderResponse` |
|
|
99
|
+
| 聚合码下单 | `AggregateCodeUnifiedOrderParams` | `AggregateCodeUnifiedOrderRequest` | `AggregateCodeUnifiedOrderResponse` |
|
|
100
|
+
| 小程序下单 | `MiniProgramUnifiedOrderParams` | `MiniProgramUnifiedOrderRequest` | `MiniProgramUnifiedOrderResponse` |
|
|
101
|
+
| H5 下单 | `H5UnifiedOrderParams` | `H5UnifiedOrderRequest` | `H5UnifiedOrderResponse` |
|
|
102
|
+
| APP 下单 | `AppUnifiedOrderParams` | `AppUnifiedOrderRequest` | `AppUnifiedOrderResponse` |
|
|
103
|
+
| 订单查询 | `OrderQueryParams` | `OrderQueryRequest` | `OrderQueryResponse` |
|
|
104
|
+
| 退款 | `RefundParams` | `RefundRequest` | `RefundResponse` |
|
|
105
|
+
| 退款查询 | `RefundQueryParams` | `RefundQueryRequest` | `RefundQueryResponse` |
|
|
106
|
+
| 撤销 | `ReverseParams` | `ReverseRequest` | `ReverseResponse` |
|
|
107
|
+
| 撤销查询 | `ReverseQueryParams` | `ReverseQueryRequest` | `ReverseQueryResponse` |
|
|
108
|
+
| 支付回调 | - | - | `PaymentNotifyResponse` |
|
|
109
|
+
| 退款回调 | - | - | `RefundNotifyResponse` |
|
|
110
|
+
|
|
111
|
+
## 响应判断
|
|
112
|
+
|
|
113
|
+
- 正向同步接口(下单、订单查询)默认使用 `responseCode == "A001"` 判断成功(`IpaynowResponse.is_success()`)。
|
|
114
|
+
- 退款、撤销、退款查询、撤销查询使用 `responseCode == "R000"` 判断成功(`_RefundFamilyResponse.is_success()`)。
|
|
115
|
+
- 支付回调用 `transStatus == "A001"` 判断成功(`PaymentNotifyResponse.is_success()`)。
|
|
116
|
+
- 退款回调用 `tradeStatus == "A001"` 判断成功(`RefundNotifyResponse.is_success()`)。
|
|
117
|
+
|
|
118
|
+
也可以直接读取原始字段:
|
|
119
|
+
|
|
120
|
+
```python
|
|
121
|
+
code = response.code()
|
|
122
|
+
message = response.message()
|
|
123
|
+
raw_body = response.raw_body()
|
|
124
|
+
fields = response.fields()
|
|
125
|
+
value = response.get("someField")
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
统一下单响应还提供 `tn()` / `now_pay_order_no()`;订单查询响应提供 `trans_status()` / `now_pay_order_no()` / `pay_time()` / `channel_order_no()`。
|
|
129
|
+
|
|
130
|
+
## 扩展字段
|
|
131
|
+
|
|
132
|
+
每个 Params 类型都支持 `extra_params`(字典),会合并进 `to_map()` 的结果。SDK 只禁止覆盖公共签名字段,业务字段不做强校验,避免网关协议扩展时 SDK 阻塞接入。
|
|
133
|
+
|
|
134
|
+
```python
|
|
135
|
+
params = H5UnifiedOrderParams(
|
|
136
|
+
mhtOrderNo="ORDER202607030001",
|
|
137
|
+
extra_params={"someNewField": "value"},
|
|
138
|
+
)
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
保留字段(`extra_params` 中若出现会抛出 `ValueError`):
|
|
142
|
+
|
|
143
|
+
- `funcode`
|
|
144
|
+
- `version`
|
|
145
|
+
- `appId`
|
|
146
|
+
- `mhtCharset`
|
|
147
|
+
- `mhtSignType`
|
|
148
|
+
- `signType`
|
|
149
|
+
- `mhtSignature`
|
|
150
|
+
- `signature`
|
|
151
|
+
|
|
152
|
+
## 回调验签
|
|
153
|
+
|
|
154
|
+
```python
|
|
155
|
+
from ipaynow_sdk import NotifyAck, NotifyParser
|
|
156
|
+
|
|
157
|
+
notify = NotifyParser.parse_payment(body, app_key)
|
|
158
|
+
if notify.is_success():
|
|
159
|
+
ack = NotifyAck.success()
|
|
160
|
+
else:
|
|
161
|
+
ack = NotifyAck.fail()
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
退款回调:
|
|
165
|
+
|
|
166
|
+
```python
|
|
167
|
+
notify = NotifyParser.parse_refund(body, app_key)
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
验签失败时 `NotifyParser` 会抛出 `IpaynowError`(`code == IpaynowErrorCode.SIGN_ERROR`),而不是返回一个“失败”的响应对象,调用方需要用 `try/except` 包裹。
|
|
171
|
+
|
|
172
|
+
## 错误处理
|
|
173
|
+
|
|
174
|
+
SDK 只抛出一种异常 `IpaynowError`,通过 `.code`(`IpaynowErrorCode` 枚举)判断具体失败类型:
|
|
175
|
+
|
|
176
|
+
```python
|
|
177
|
+
from ipaynow_sdk import IpaynowError, IpaynowErrorCode
|
|
178
|
+
|
|
179
|
+
try:
|
|
180
|
+
response = client.execute(request)
|
|
181
|
+
except IpaynowError as e:
|
|
182
|
+
if e.code is IpaynowErrorCode.SIGN_ERROR:
|
|
183
|
+
...
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
错误码表:
|
|
187
|
+
|
|
188
|
+
| 错误码 | 枚举 | 说明 |
|
|
189
|
+
| --- | --- | --- |
|
|
190
|
+
| `E0001` | `IpaynowErrorCode.SYSTEM_ERROR` | 组件内部异常 |
|
|
191
|
+
| `E0002` | `IpaynowErrorCode.HTTP_EXCEPTION` | HTTP 异常 |
|
|
192
|
+
| `E0003` | `IpaynowErrorCode.CONNECT_TIMEOUT` | 建连超时 |
|
|
193
|
+
| `E0004` | `IpaynowErrorCode.SOCKET_TIMEOUT` | 读超时 |
|
|
194
|
+
| `E0012` | `IpaynowErrorCode.SIGN_ERROR` | 渠道报文验签失败 |
|
|
195
|
+
|
|
196
|
+
业务成功/失败(如余额不足、订单不存在)请从 `response.is_success()` / `response.code()` / `response.message()` 读取,不会以异常形式抛出。
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
ipaynow_sdk/__init__.py,sha256=44cPgjcsVR__joYZAzBlNAaaf99eYgVG583cLIeLETQ,2440
|
|
2
|
+
ipaynow_sdk/client.py,sha256=tpG7JXXfJ-mE9Phe2BLBf-CfGRkO1lXTWh3V9xoYvAY,3149
|
|
3
|
+
ipaynow_sdk/config.py,sha256=1xlgPrW78Dcw-Oc4cdC70u-MLQkFe3X5Uz3xXSiQWxg,2958
|
|
4
|
+
ipaynow_sdk/errors.py,sha256=ZPBPEJVSXtdwSNWbumTGeTkKoHgYR_I2Q_PKlvmYAI8,1037
|
|
5
|
+
ipaynow_sdk/notify.py,sha256=-Gx2xnkz9T1knkzwgAaGWXOyJMFoJoOV46EZZ0p_9Us,1468
|
|
6
|
+
ipaynow_sdk/params.py,sha256=Uwhr4v1fh1fkHIQWe7IIR-I2a3arce4qOV0Fzd4FNCA,5920
|
|
7
|
+
ipaynow_sdk/parser.py,sha256=4nwdaC5OBGpsk_G2zvS1y-S1Y3cBxrf4ngH2EasDeXo,506
|
|
8
|
+
ipaynow_sdk/requests.py,sha256=eyn6r-7PPgYB-VWcL7YuajNwDJt7qdgzMcEAM0yn1hE,4744
|
|
9
|
+
ipaynow_sdk/responses.py,sha256=qs36kVxXsFjfU183ineNkYu33yuMAihET1mM4JKTqvE,2552
|
|
10
|
+
ipaynow_sdk/signer.py,sha256=eoBJJ6yszqs8TSmTiNUinDhTwEkicSVJi1TABQUcpDs,3063
|
|
11
|
+
ipaynow_sdk/transport.py,sha256=jNPHWqTOl7bQfUDVUm8YMjgruaJpOanUZZzsTdRyMqA,2577
|
|
12
|
+
ipaynow_python_sdk-1.0.0.dist-info/METADATA,sha256=VvhxP1RkZuIFNqEUDBgzWvR3rNxnwp96dUD5EFZAagA,6294
|
|
13
|
+
ipaynow_python_sdk-1.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
|
|
14
|
+
ipaynow_python_sdk-1.0.0.dist-info/top_level.txt,sha256=Xi6ZcFQXZmBSJvdBbayf6gZvp8YOmnYev8iQYb7Txco,12
|
|
15
|
+
ipaynow_python_sdk-1.0.0.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
ipaynow_sdk
|
ipaynow_sdk/__init__.py
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
from .client import IpaynowClient
|
|
2
|
+
from .config import IpaynowConfig, SignType
|
|
3
|
+
from .errors import IpaynowError, IpaynowErrorCode
|
|
4
|
+
from .notify import NotifyAck, NotifyParser
|
|
5
|
+
from .params import (
|
|
6
|
+
AggregateCodeUnifiedOrderParams,
|
|
7
|
+
AppUnifiedOrderParams,
|
|
8
|
+
H5UnifiedOrderParams,
|
|
9
|
+
JsapiUnifiedOrderParams,
|
|
10
|
+
MiniProgramUnifiedOrderParams,
|
|
11
|
+
OrderQueryParams,
|
|
12
|
+
RefundParams,
|
|
13
|
+
RefundQueryParams,
|
|
14
|
+
ReverseParams,
|
|
15
|
+
ReverseQueryParams,
|
|
16
|
+
)
|
|
17
|
+
from .requests import (
|
|
18
|
+
AggregateCodeUnifiedOrderRequest,
|
|
19
|
+
AppUnifiedOrderRequest,
|
|
20
|
+
H5UnifiedOrderRequest,
|
|
21
|
+
IpaynowRequest,
|
|
22
|
+
JsapiUnifiedOrderRequest,
|
|
23
|
+
MiniProgramUnifiedOrderRequest,
|
|
24
|
+
OrderQueryRequest,
|
|
25
|
+
RefundQueryRequest,
|
|
26
|
+
RefundRequest,
|
|
27
|
+
ReverseQueryRequest,
|
|
28
|
+
ReverseRequest,
|
|
29
|
+
)
|
|
30
|
+
from .responses import (
|
|
31
|
+
AggregateCodeUnifiedOrderResponse,
|
|
32
|
+
AppUnifiedOrderResponse,
|
|
33
|
+
H5UnifiedOrderResponse,
|
|
34
|
+
IpaynowResponse,
|
|
35
|
+
JsapiUnifiedOrderResponse,
|
|
36
|
+
MiniProgramUnifiedOrderResponse,
|
|
37
|
+
OrderQueryResponse,
|
|
38
|
+
PaymentNotifyResponse,
|
|
39
|
+
RefundNotifyResponse,
|
|
40
|
+
RefundQueryResponse,
|
|
41
|
+
RefundResponse,
|
|
42
|
+
ReverseQueryResponse,
|
|
43
|
+
ReverseResponse,
|
|
44
|
+
UnifiedOrderResponse,
|
|
45
|
+
)
|
|
46
|
+
from .transport import HttpTransport, UrllibHttpTransport
|
|
47
|
+
|
|
48
|
+
__all__ = [
|
|
49
|
+
"IpaynowClient",
|
|
50
|
+
"IpaynowConfig",
|
|
51
|
+
"SignType",
|
|
52
|
+
"IpaynowError",
|
|
53
|
+
"IpaynowErrorCode",
|
|
54
|
+
"NotifyAck",
|
|
55
|
+
"NotifyParser",
|
|
56
|
+
"AggregateCodeUnifiedOrderParams",
|
|
57
|
+
"AppUnifiedOrderParams",
|
|
58
|
+
"H5UnifiedOrderParams",
|
|
59
|
+
"JsapiUnifiedOrderParams",
|
|
60
|
+
"MiniProgramUnifiedOrderParams",
|
|
61
|
+
"OrderQueryParams",
|
|
62
|
+
"RefundParams",
|
|
63
|
+
"RefundQueryParams",
|
|
64
|
+
"ReverseParams",
|
|
65
|
+
"ReverseQueryParams",
|
|
66
|
+
"IpaynowRequest",
|
|
67
|
+
"AggregateCodeUnifiedOrderRequest",
|
|
68
|
+
"AppUnifiedOrderRequest",
|
|
69
|
+
"H5UnifiedOrderRequest",
|
|
70
|
+
"JsapiUnifiedOrderRequest",
|
|
71
|
+
"MiniProgramUnifiedOrderRequest",
|
|
72
|
+
"OrderQueryRequest",
|
|
73
|
+
"RefundQueryRequest",
|
|
74
|
+
"RefundRequest",
|
|
75
|
+
"ReverseQueryRequest",
|
|
76
|
+
"ReverseRequest",
|
|
77
|
+
"IpaynowResponse",
|
|
78
|
+
"UnifiedOrderResponse",
|
|
79
|
+
"AggregateCodeUnifiedOrderResponse",
|
|
80
|
+
"AppUnifiedOrderResponse",
|
|
81
|
+
"H5UnifiedOrderResponse",
|
|
82
|
+
"JsapiUnifiedOrderResponse",
|
|
83
|
+
"MiniProgramUnifiedOrderResponse",
|
|
84
|
+
"OrderQueryResponse",
|
|
85
|
+
"PaymentNotifyResponse",
|
|
86
|
+
"RefundNotifyResponse",
|
|
87
|
+
"RefundQueryResponse",
|
|
88
|
+
"RefundResponse",
|
|
89
|
+
"ReverseQueryResponse",
|
|
90
|
+
"ReverseResponse",
|
|
91
|
+
"HttpTransport",
|
|
92
|
+
"UrllibHttpTransport",
|
|
93
|
+
]
|
ipaynow_sdk/client.py
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"""Client:组装公共字段 -> 签名 -> POST 表单 -> 解析响应 -> 验签 -> 类型化 Response。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import logging
|
|
6
|
+
from typing import Dict, Optional
|
|
7
|
+
|
|
8
|
+
from .config import IpaynowConfig
|
|
9
|
+
from .errors import IpaynowError, IpaynowErrorCode
|
|
10
|
+
from .parser import parse_response
|
|
11
|
+
from .requests import IpaynowRequest
|
|
12
|
+
from .responses import IpaynowResponse
|
|
13
|
+
from .signer import clean, sign, verify
|
|
14
|
+
from .transport import HttpTransport, UrllibHttpTransport
|
|
15
|
+
|
|
16
|
+
log = logging.getLogger(__name__)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def _redact(fields: Dict[str, str]) -> Dict[str, str]:
|
|
20
|
+
"""请求/响应报文仅 DEBUG 输出,签名字段值脱敏(规范 §8)。"""
|
|
21
|
+
return {
|
|
22
|
+
key: ("***" if key in ("mhtSignature", "signature") else value)
|
|
23
|
+
for key, value in fields.items()
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class IpaynowClient:
|
|
28
|
+
def __init__(self, config: IpaynowConfig, transport: Optional[HttpTransport] = None) -> None:
|
|
29
|
+
self.config = config
|
|
30
|
+
self.transport = transport or UrllibHttpTransport(
|
|
31
|
+
config.connect_timeout_ms, config.read_timeout_ms
|
|
32
|
+
)
|
|
33
|
+
|
|
34
|
+
def execute(self, request: IpaynowRequest) -> IpaynowResponse:
|
|
35
|
+
funcode = request.funcode
|
|
36
|
+
exclude_sign_type = request.exclude_sign_type
|
|
37
|
+
params = self._signed_fields(request)
|
|
38
|
+
if log.isEnabledFor(logging.DEBUG):
|
|
39
|
+
log.debug("功能码=%s,请求报文=%s", funcode, _redact(params))
|
|
40
|
+
|
|
41
|
+
response_text = self.transport.post(self.config.endpoint(request.path), params)
|
|
42
|
+
|
|
43
|
+
fields = parse_response(response_text)
|
|
44
|
+
if log.isEnabledFor(logging.DEBUG):
|
|
45
|
+
log.debug("功能码=%s,响应报文=%s", funcode, _redact(fields))
|
|
46
|
+
|
|
47
|
+
if not verify(fields, self.config, request.response_signature_field, exclude_sign_type):
|
|
48
|
+
log.warning("功能码=%s,签名缺失或验签失败", funcode)
|
|
49
|
+
raise IpaynowError(IpaynowErrorCode.SIGN_ERROR, f"现在支付响应验签失败,功能码={funcode}")
|
|
50
|
+
|
|
51
|
+
try:
|
|
52
|
+
response = request.response_class()
|
|
53
|
+
except Exception as e: # noqa: BLE001 - 对齐 Java 参考实现的 SYSTEM_ERROR 语义
|
|
54
|
+
raise IpaynowError(
|
|
55
|
+
IpaynowErrorCode.SYSTEM_ERROR,
|
|
56
|
+
f"响应类必须提供无参构造方法: {request.response_class}",
|
|
57
|
+
) from e
|
|
58
|
+
response.load(fields, response_text)
|
|
59
|
+
return response
|
|
60
|
+
|
|
61
|
+
def build_form_fields(self, request: IpaynowRequest) -> Dict[str, str]:
|
|
62
|
+
return self._signed_fields(request)
|
|
63
|
+
|
|
64
|
+
def _signed_fields(self, request: IpaynowRequest) -> Dict[str, str]:
|
|
65
|
+
params: Dict[str, object] = dict(request.to_params())
|
|
66
|
+
params["funcode"] = request.funcode
|
|
67
|
+
params["version"] = request.version
|
|
68
|
+
params["appId"] = self.config.app_id
|
|
69
|
+
params["mhtCharset"] = request.mht_charset
|
|
70
|
+
params[request.sign_type_field] = self.config.sign_type.value
|
|
71
|
+
params[request.signature_field] = sign(
|
|
72
|
+
params,
|
|
73
|
+
self.config,
|
|
74
|
+
request.exclude_sign_type,
|
|
75
|
+
request.signature_field,
|
|
76
|
+
request.response_signature_field,
|
|
77
|
+
)
|
|
78
|
+
return clean(params)
|
ipaynow_sdk/config.py
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"""SDK 配置:appId / appKey / baseUrl / 超时(规范 §1)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import base64
|
|
6
|
+
from dataclasses import dataclass
|
|
7
|
+
from enum import Enum
|
|
8
|
+
|
|
9
|
+
from cryptography.hazmat.primitives import serialization
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def _require_non_blank(value: str, name: str) -> str:
|
|
13
|
+
if value is None or not str(value).strip():
|
|
14
|
+
raise ValueError(f"{name} 不能为空")
|
|
15
|
+
return value
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class SignType(Enum):
|
|
19
|
+
MD5 = "MD5"
|
|
20
|
+
RSA = "RSA"
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
def _decode_base64(value: str, name: str) -> bytes:
|
|
24
|
+
if "-----BEGIN" in value or "-----END" in value:
|
|
25
|
+
raise ValueError(f"{name} 仅支持裸 base64,不支持 PEM")
|
|
26
|
+
try:
|
|
27
|
+
return base64.b64decode("".join(value.split()), validate=True)
|
|
28
|
+
except Exception as exc: # noqa: BLE001
|
|
29
|
+
raise ValueError(f"{name} 非法,需传裸 base64") from exc
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
@dataclass
|
|
33
|
+
class IpaynowConfig:
|
|
34
|
+
app_id: str
|
|
35
|
+
app_key: str | None = None
|
|
36
|
+
sign_type: SignType = SignType.MD5
|
|
37
|
+
mch_private_key: str | None = None
|
|
38
|
+
ipaynow_public_key: str | None = None
|
|
39
|
+
base_url: str = "https://pay.ipaynow.cn"
|
|
40
|
+
connect_timeout_ms: int = 5000
|
|
41
|
+
read_timeout_ms: int = 15000
|
|
42
|
+
mch_private_key_object: object | None = None
|
|
43
|
+
ipaynow_public_key_object: object | None = None
|
|
44
|
+
|
|
45
|
+
def __post_init__(self) -> None:
|
|
46
|
+
self.app_id = _require_non_blank(self.app_id, "appId")
|
|
47
|
+
if self.sign_type is SignType.MD5:
|
|
48
|
+
self.app_key = _require_non_blank(self.app_key, "appKey")
|
|
49
|
+
self.mch_private_key = None
|
|
50
|
+
self.ipaynow_public_key = None
|
|
51
|
+
self.mch_private_key_object = None
|
|
52
|
+
self.ipaynow_public_key_object = None
|
|
53
|
+
elif self.sign_type is SignType.RSA:
|
|
54
|
+
self.app_key = None
|
|
55
|
+
self.mch_private_key = _require_non_blank(self.mch_private_key, "mchPrivateKey")
|
|
56
|
+
self.ipaynow_public_key = _require_non_blank(self.ipaynow_public_key, "ipaynowPublicKey")
|
|
57
|
+
self.mch_private_key_object = serialization.load_der_private_key(
|
|
58
|
+
_decode_base64(self.mch_private_key, "mchPrivateKey"),
|
|
59
|
+
password=None,
|
|
60
|
+
)
|
|
61
|
+
self.ipaynow_public_key_object = serialization.load_der_public_key(
|
|
62
|
+
_decode_base64(self.ipaynow_public_key, "ipaynowPublicKey")
|
|
63
|
+
)
|
|
64
|
+
else:
|
|
65
|
+
raise ValueError(f"不支持的签名类型: {self.sign_type}")
|
|
66
|
+
self.base_url = _require_non_blank(self.base_url, "baseUrl")
|
|
67
|
+
if self.connect_timeout_ms <= 0 or self.read_timeout_ms <= 0:
|
|
68
|
+
raise ValueError(
|
|
69
|
+
"超时时间必须大于 0:"
|
|
70
|
+
f"connectTimeoutMillis={self.connect_timeout_ms},"
|
|
71
|
+
f"readTimeoutMillis={self.read_timeout_ms}"
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
def endpoint(self, path: str) -> str:
|
|
75
|
+
normalized = path if path else "/"
|
|
76
|
+
if not normalized.startswith("/"):
|
|
77
|
+
normalized = "/" + normalized
|
|
78
|
+
return self.base_url.rstrip("/") + normalized
|
ipaynow_sdk/errors.py
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"""统一错误码与异常类型(规范 §7)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import enum
|
|
6
|
+
from typing import Optional
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class IpaynowErrorCode(enum.Enum):
|
|
10
|
+
"""SDK 实际会抛出的失败码。业务成功/失败请从 Response.is_success() 读取。"""
|
|
11
|
+
|
|
12
|
+
SYSTEM_ERROR = ("E0001", "组件内部异常")
|
|
13
|
+
HTTP_EXCEPTION = ("E0002", "HTTP异常")
|
|
14
|
+
CONNECT_TIMEOUT = ("E0003", "ConnectTimeOut")
|
|
15
|
+
SOCKET_TIMEOUT = ("E0004", "SocketTimeOut")
|
|
16
|
+
SIGN_ERROR = ("E0012", "渠道报文验签失败")
|
|
17
|
+
|
|
18
|
+
def __new__(cls, code: str, default_message: str):
|
|
19
|
+
obj = object.__new__(cls)
|
|
20
|
+
obj._value_ = code
|
|
21
|
+
obj.code = code
|
|
22
|
+
obj.default_message = default_message
|
|
23
|
+
return obj
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
class IpaynowError(Exception):
|
|
27
|
+
"""现在支付 SDK 统一异常,调用方只捕获这一种,通过 .code 判断具体失败类型。"""
|
|
28
|
+
|
|
29
|
+
def __init__(self, code: IpaynowErrorCode, message: Optional[str] = None):
|
|
30
|
+
super().__init__(message or code.default_message)
|
|
31
|
+
self.code = code
|
ipaynow_sdk/notify.py
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"""回调解析与同步应答(规范 §1)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import logging
|
|
6
|
+
|
|
7
|
+
from .config import IpaynowConfig
|
|
8
|
+
from .errors import IpaynowError, IpaynowErrorCode
|
|
9
|
+
from .parser import parse_response
|
|
10
|
+
from .responses import PaymentNotifyResponse, RefundNotifyResponse
|
|
11
|
+
from .signer import verify
|
|
12
|
+
|
|
13
|
+
log = logging.getLogger(__name__)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class NotifyAck:
|
|
17
|
+
@staticmethod
|
|
18
|
+
def success() -> str:
|
|
19
|
+
return "success=Y"
|
|
20
|
+
|
|
21
|
+
@staticmethod
|
|
22
|
+
def fail() -> str:
|
|
23
|
+
return "success=N"
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
class NotifyParser:
|
|
27
|
+
@staticmethod
|
|
28
|
+
def parse_payment(body: str, config: IpaynowConfig) -> PaymentNotifyResponse:
|
|
29
|
+
# N001 属于正向交易通知,signType 参与签名。
|
|
30
|
+
return NotifyParser._parse(body, config, False, PaymentNotifyResponse())
|
|
31
|
+
|
|
32
|
+
@staticmethod
|
|
33
|
+
def parse_refund(body: str, config: IpaynowConfig) -> RefundNotifyResponse:
|
|
34
|
+
# RN001 属于退款链路通知,signType 不参与签名。
|
|
35
|
+
return NotifyParser._parse(body, config, True, RefundNotifyResponse())
|
|
36
|
+
|
|
37
|
+
@staticmethod
|
|
38
|
+
def _parse(body, config, exclude_sign_type, response):
|
|
39
|
+
fields = parse_response(body)
|
|
40
|
+
if not verify(fields, config, "signature", exclude_sign_type):
|
|
41
|
+
log.warning("拒绝现在支付回调通知,签名缺失或验签失败")
|
|
42
|
+
raise IpaynowError(IpaynowErrorCode.SIGN_ERROR, "现在支付回调通知验签失败")
|
|
43
|
+
response.load(fields, body)
|
|
44
|
+
return response
|
ipaynow_sdk/params.py
ADDED
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
"""每操作入参类型(规范 §5)。
|
|
2
|
+
|
|
3
|
+
字段名直接采用规范原文(camelCase),减少与 Java 参考实现比对时的映射误差。
|
|
4
|
+
每个类型都提供 extra_params:dict 透传通道,合并进 to_map() 结果;
|
|
5
|
+
若 key 与 SDK 保留字段(公共字段/签名字段)冲突则报错,行为对齐 Java BeanMap。
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from __future__ import annotations
|
|
9
|
+
|
|
10
|
+
import dataclasses
|
|
11
|
+
from dataclasses import dataclass, field
|
|
12
|
+
from typing import Any, Dict, Optional
|
|
13
|
+
|
|
14
|
+
RESERVED_FIELDS = frozenset(
|
|
15
|
+
{
|
|
16
|
+
"funcode",
|
|
17
|
+
"version",
|
|
18
|
+
"appId",
|
|
19
|
+
"mhtCharset",
|
|
20
|
+
"mhtSignType",
|
|
21
|
+
"signType",
|
|
22
|
+
"mhtSignature",
|
|
23
|
+
"signature",
|
|
24
|
+
}
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
@dataclass
|
|
29
|
+
class _ParamsBase:
|
|
30
|
+
extra_params: Dict[str, Any] = field(default_factory=dict)
|
|
31
|
+
|
|
32
|
+
def to_map(self) -> Dict[str, str]:
|
|
33
|
+
out: Dict[str, str] = {}
|
|
34
|
+
for f in dataclasses.fields(self):
|
|
35
|
+
if f.name == "extra_params":
|
|
36
|
+
continue
|
|
37
|
+
value = getattr(self, f.name)
|
|
38
|
+
if value is None:
|
|
39
|
+
continue
|
|
40
|
+
out[f.name] = str(value)
|
|
41
|
+
for key, value in self.extra_params.items():
|
|
42
|
+
if key in RESERVED_FIELDS:
|
|
43
|
+
raise ValueError(f"extraParams 不能覆盖 SDK 保留字段: {key}")
|
|
44
|
+
if value is not None:
|
|
45
|
+
out[key] = str(value)
|
|
46
|
+
return out
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
@dataclass
|
|
50
|
+
class JsapiUnifiedOrderParams(_ParamsBase):
|
|
51
|
+
consumerCreateIp: Optional[str] = None
|
|
52
|
+
consumerId: Optional[str] = None
|
|
53
|
+
deviceType: str = "0600"
|
|
54
|
+
frontNotifyUrl: Optional[str] = None
|
|
55
|
+
mhtCurrencyType: str = "156"
|
|
56
|
+
mhtGoodsTag: Optional[str] = None
|
|
57
|
+
mhtGoodsDetails: Optional[str] = None
|
|
58
|
+
mhtLimitPay: Optional[str] = None
|
|
59
|
+
mhtOrderAmt: Optional[int] = None
|
|
60
|
+
mhtOrderDetail: Optional[str] = None
|
|
61
|
+
mhtOrderName: Optional[str] = None
|
|
62
|
+
mhtOrderNo: Optional[str] = None
|
|
63
|
+
mhtOrderStartTime: Optional[str] = None
|
|
64
|
+
mhtOrderTimeOut: int = 120
|
|
65
|
+
mhtOrderType: str = "05"
|
|
66
|
+
mhtReserved: Optional[str] = None
|
|
67
|
+
mhtSubAppId: Optional[str] = None
|
|
68
|
+
notifyUrl: Optional[str] = None
|
|
69
|
+
outputType: Optional[str] = None
|
|
70
|
+
payChannelType: Optional[str] = None
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
@dataclass
|
|
74
|
+
class AggregateCodeUnifiedOrderParams(_ParamsBase):
|
|
75
|
+
deviceType: str = "20"
|
|
76
|
+
mhtCurrencyType: str = "156"
|
|
77
|
+
mhtLimitPay: Optional[str] = None
|
|
78
|
+
mhtOrderAmt: Optional[int] = None
|
|
79
|
+
mhtOrderDetail: Optional[str] = None
|
|
80
|
+
mhtOrderName: Optional[str] = None
|
|
81
|
+
mhtOrderNo: Optional[str] = None
|
|
82
|
+
mhtOrderStartTime: Optional[str] = None
|
|
83
|
+
mhtOrderTimeOut: int = 120
|
|
84
|
+
mhtOrderType: str = "05"
|
|
85
|
+
mhtReserved: Optional[str] = None
|
|
86
|
+
notifyUrl: Optional[str] = None
|
|
87
|
+
outputType: Optional[str] = None
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
@dataclass
|
|
91
|
+
class MiniProgramUnifiedOrderParams(_ParamsBase):
|
|
92
|
+
consumerId: Optional[str] = None
|
|
93
|
+
deviceType: str = "14"
|
|
94
|
+
discountAmt: Optional[int] = None
|
|
95
|
+
mhtCurrencyType: str = "156"
|
|
96
|
+
mhtGoodsTag: Optional[str] = None
|
|
97
|
+
mhtGoodsDetails: Optional[str] = None
|
|
98
|
+
mhtLimitPay: Optional[str] = None
|
|
99
|
+
mhtOrderAmt: Optional[int] = None
|
|
100
|
+
mhtOrderDetail: Optional[str] = None
|
|
101
|
+
mhtOrderName: Optional[str] = None
|
|
102
|
+
mhtOrderNo: Optional[str] = None
|
|
103
|
+
mhtOrderStartTime: Optional[str] = None
|
|
104
|
+
mhtOrderTimeOut: int = 120
|
|
105
|
+
mhtOrderType: str = "05"
|
|
106
|
+
mhtReserved: Optional[str] = None
|
|
107
|
+
mhtSubAppId: Optional[str] = None
|
|
108
|
+
notifyUrl: Optional[str] = None
|
|
109
|
+
oriMhtOrderAmt: Optional[int] = None
|
|
110
|
+
outputType: str = "1"
|
|
111
|
+
payChannelType: Optional[str] = None
|
|
112
|
+
mhtStoreId: Optional[str] = None
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
@dataclass
|
|
116
|
+
class H5UnifiedOrderParams(_ParamsBase):
|
|
117
|
+
consumerCreateIp: Optional[str] = None
|
|
118
|
+
consumerId: Optional[str] = None
|
|
119
|
+
deviceType: str = "0601"
|
|
120
|
+
frontNotifyUrl: Optional[str] = None
|
|
121
|
+
mhtCurrencyType: str = "156"
|
|
122
|
+
mhtLimitPay: Optional[str] = None
|
|
123
|
+
mhtOrderAmt: Optional[int] = None
|
|
124
|
+
mhtOrderDetail: Optional[str] = None
|
|
125
|
+
mhtOrderName: Optional[str] = None
|
|
126
|
+
mhtOrderNo: Optional[str] = None
|
|
127
|
+
mhtOrderStartTime: Optional[str] = None
|
|
128
|
+
mhtOrderTimeOut: int = 120
|
|
129
|
+
mhtOrderType: str = "05"
|
|
130
|
+
mhtReserved: Optional[str] = None
|
|
131
|
+
notifyUrl: Optional[str] = None
|
|
132
|
+
outputType: Optional[str] = None
|
|
133
|
+
payChannelType: Optional[str] = None
|
|
134
|
+
specifiedChannel: Optional[str] = None
|
|
135
|
+
payAccNo: Optional[str] = None
|
|
136
|
+
guideId: Optional[str] = None
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
@dataclass
|
|
140
|
+
class AppUnifiedOrderParams(_ParamsBase):
|
|
141
|
+
consumerCreateIp: Optional[str] = None
|
|
142
|
+
consumerId: Optional[str] = None
|
|
143
|
+
consumerName: Optional[str] = None
|
|
144
|
+
deviceType: str = "01"
|
|
145
|
+
mhtCurrencyType: str = "156"
|
|
146
|
+
mhtLimitPay: Optional[str] = None
|
|
147
|
+
mhtOrderAmt: Optional[int] = None
|
|
148
|
+
mhtOrderDetail: Optional[str] = None
|
|
149
|
+
mhtOrderName: Optional[str] = None
|
|
150
|
+
mhtOrderNo: Optional[str] = None
|
|
151
|
+
mhtOrderStartTime: Optional[str] = None
|
|
152
|
+
mhtOrderTimeOut: int = 120
|
|
153
|
+
mhtOrderType: str = "05"
|
|
154
|
+
mhtReserved: Optional[str] = None
|
|
155
|
+
mhtSubAppId: Optional[str] = None
|
|
156
|
+
notifyUrl: Optional[str] = None
|
|
157
|
+
payChannelType: Optional[str] = None
|
|
158
|
+
outputType: str = "0"
|
|
159
|
+
frontNotifyUrl: Optional[str] = None
|
|
160
|
+
mhtStoreId: Optional[str] = None
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
@dataclass
|
|
164
|
+
class OrderQueryParams(_ParamsBase):
|
|
165
|
+
deviceType: Optional[str] = None
|
|
166
|
+
mhtOrderNo: Optional[str] = None
|
|
167
|
+
version: Optional[str] = None
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
@dataclass
|
|
171
|
+
class RefundParams(_ParamsBase):
|
|
172
|
+
amount: Optional[int] = None
|
|
173
|
+
mhtOrderNo: Optional[str] = None
|
|
174
|
+
mhtRefundNo: Optional[str] = None
|
|
175
|
+
notifyUrl: Optional[str] = None
|
|
176
|
+
oriTransId: Optional[str] = None
|
|
177
|
+
reason: Optional[str] = None
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
@dataclass
|
|
181
|
+
class RefundQueryParams(_ParamsBase):
|
|
182
|
+
mhtRefundNo: Optional[str] = None
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
@dataclass
|
|
186
|
+
class ReverseParams(_ParamsBase):
|
|
187
|
+
mhtRefundNo: Optional[str] = None
|
|
188
|
+
mhtOrderNo: Optional[str] = None
|
|
189
|
+
oriTransId: Optional[str] = None
|
|
190
|
+
reason: Optional[str] = None
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
@dataclass
|
|
194
|
+
class ReverseQueryParams(_ParamsBase):
|
|
195
|
+
mhtRefundNo: Optional[str] = None
|
ipaynow_sdk/parser.py
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"""表单响应报文解析(k=v&k2=v2,值需 URL-decode)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Dict, Optional
|
|
6
|
+
from urllib.parse import unquote_plus
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def parse_response(text: Optional[str]) -> Dict[str, str]:
|
|
10
|
+
trimmed = (text or "").strip()
|
|
11
|
+
if not trimmed:
|
|
12
|
+
return {}
|
|
13
|
+
out: Dict[str, str] = {}
|
|
14
|
+
for part in trimmed.split("&"):
|
|
15
|
+
key, sep, value = part.partition("=")
|
|
16
|
+
out[unquote_plus(key)] = unquote_plus(value) if sep else ""
|
|
17
|
+
return out
|
ipaynow_sdk/requests.py
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
"""每操作一个 Request 类(规范 §2)。禁止集中式 Requests 工厂。
|
|
2
|
+
|
|
3
|
+
IpaynowRequest 是携带公共元数据/行为的基类(funcode/version/path/签名字段名/
|
|
4
|
+
excludeSignType),每个操作子类只负责声明自己的元数据,不对外暴露统一入口。
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from __future__ import annotations
|
|
8
|
+
|
|
9
|
+
from typing import Any, Dict, Type
|
|
10
|
+
|
|
11
|
+
from .params import (
|
|
12
|
+
AggregateCodeUnifiedOrderParams,
|
|
13
|
+
AppUnifiedOrderParams,
|
|
14
|
+
H5UnifiedOrderParams,
|
|
15
|
+
JsapiUnifiedOrderParams,
|
|
16
|
+
MiniProgramUnifiedOrderParams,
|
|
17
|
+
OrderQueryParams,
|
|
18
|
+
RefundParams,
|
|
19
|
+
RefundQueryParams,
|
|
20
|
+
ReverseParams,
|
|
21
|
+
ReverseQueryParams,
|
|
22
|
+
)
|
|
23
|
+
from .responses import (
|
|
24
|
+
AggregateCodeUnifiedOrderResponse,
|
|
25
|
+
AppUnifiedOrderResponse,
|
|
26
|
+
H5UnifiedOrderResponse,
|
|
27
|
+
IpaynowResponse,
|
|
28
|
+
JsapiUnifiedOrderResponse,
|
|
29
|
+
MiniProgramUnifiedOrderResponse,
|
|
30
|
+
OrderQueryResponse,
|
|
31
|
+
RefundQueryResponse,
|
|
32
|
+
RefundResponse,
|
|
33
|
+
ReverseQueryResponse,
|
|
34
|
+
ReverseResponse,
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
class IpaynowRequest:
|
|
39
|
+
def __init__(
|
|
40
|
+
self,
|
|
41
|
+
funcode: str,
|
|
42
|
+
version: str,
|
|
43
|
+
params: Any,
|
|
44
|
+
response_class: Type[IpaynowResponse],
|
|
45
|
+
*,
|
|
46
|
+
path: str = "/",
|
|
47
|
+
mht_charset: str = "UTF-8",
|
|
48
|
+
sign_type_field: str = "mhtSignType",
|
|
49
|
+
signature_field: str = "mhtSignature",
|
|
50
|
+
response_signature_field: str = "signature",
|
|
51
|
+
exclude_sign_type: bool = False,
|
|
52
|
+
) -> None:
|
|
53
|
+
self.funcode = funcode
|
|
54
|
+
self.version = version
|
|
55
|
+
self.params = params
|
|
56
|
+
self.response_class = response_class
|
|
57
|
+
self.path = path
|
|
58
|
+
self.mht_charset = mht_charset
|
|
59
|
+
self.sign_type_field = sign_type_field
|
|
60
|
+
self.signature_field = signature_field
|
|
61
|
+
self.response_signature_field = response_signature_field
|
|
62
|
+
self.exclude_sign_type = exclude_sign_type
|
|
63
|
+
|
|
64
|
+
def to_params(self) -> Dict[str, str]:
|
|
65
|
+
return self.params.to_map()
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
class JsapiUnifiedOrderRequest(IpaynowRequest):
|
|
69
|
+
def __init__(self, params: JsapiUnifiedOrderParams, version: str = "1.0.0") -> None:
|
|
70
|
+
super().__init__("WP001", version, params, JsapiUnifiedOrderResponse)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
class AggregateCodeUnifiedOrderRequest(IpaynowRequest):
|
|
74
|
+
def __init__(self, params: AggregateCodeUnifiedOrderParams, version: str = "1.0.3") -> None:
|
|
75
|
+
super().__init__("WP001", version, params, AggregateCodeUnifiedOrderResponse)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
class MiniProgramUnifiedOrderRequest(IpaynowRequest):
|
|
79
|
+
def __init__(self, params: MiniProgramUnifiedOrderParams, version: str = "1.0.0") -> None:
|
|
80
|
+
super().__init__("WP001", version, params, MiniProgramUnifiedOrderResponse)
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
class H5UnifiedOrderRequest(IpaynowRequest):
|
|
84
|
+
def __init__(self, params: H5UnifiedOrderParams, version: str = "1.0.0") -> None:
|
|
85
|
+
super().__init__("WP001", version, params, H5UnifiedOrderResponse)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
class AppUnifiedOrderRequest(IpaynowRequest):
|
|
89
|
+
def __init__(self, params: AppUnifiedOrderParams, version: str = "1.0.3") -> None:
|
|
90
|
+
super().__init__("WP001", version, params, AppUnifiedOrderResponse)
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
class OrderQueryRequest(IpaynowRequest):
|
|
94
|
+
def __init__(self, params: OrderQueryParams) -> None:
|
|
95
|
+
fields = params.to_map()
|
|
96
|
+
version = fields.get("version") or "1.0.0"
|
|
97
|
+
super().__init__("MQ002", version, params, OrderQueryResponse)
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
class RefundRequest(IpaynowRequest):
|
|
101
|
+
def __init__(self, params: RefundParams, version: str = "1.0.0") -> None:
|
|
102
|
+
super().__init__(
|
|
103
|
+
"R001",
|
|
104
|
+
version,
|
|
105
|
+
params,
|
|
106
|
+
RefundResponse,
|
|
107
|
+
path="/refund/refundOrder",
|
|
108
|
+
sign_type_field="signType",
|
|
109
|
+
exclude_sign_type=True,
|
|
110
|
+
)
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
class RefundQueryRequest(IpaynowRequest):
|
|
114
|
+
def __init__(self, params: RefundQueryParams, version: str = "1.0.0") -> None:
|
|
115
|
+
super().__init__(
|
|
116
|
+
"Q001",
|
|
117
|
+
version,
|
|
118
|
+
params,
|
|
119
|
+
RefundQueryResponse,
|
|
120
|
+
path="/refund/refundQuery",
|
|
121
|
+
sign_type_field="signType",
|
|
122
|
+
exclude_sign_type=True,
|
|
123
|
+
)
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
class ReverseRequest(IpaynowRequest):
|
|
127
|
+
def __init__(self, params: ReverseParams, version: str = "1.0.0") -> None:
|
|
128
|
+
super().__init__(
|
|
129
|
+
"R002",
|
|
130
|
+
version,
|
|
131
|
+
params,
|
|
132
|
+
ReverseResponse,
|
|
133
|
+
path="/refund/cancelOrder",
|
|
134
|
+
sign_type_field="signType",
|
|
135
|
+
exclude_sign_type=True,
|
|
136
|
+
)
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
class ReverseQueryRequest(IpaynowRequest):
|
|
140
|
+
def __init__(self, params: ReverseQueryParams, version: str = "1.0.0") -> None:
|
|
141
|
+
super().__init__(
|
|
142
|
+
"Q002",
|
|
143
|
+
version,
|
|
144
|
+
params,
|
|
145
|
+
ReverseQueryResponse,
|
|
146
|
+
path="/refund/refundQuery",
|
|
147
|
+
sign_type_field="signType",
|
|
148
|
+
exclude_sign_type=True,
|
|
149
|
+
)
|
ipaynow_sdk/responses.py
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"""响应类型与 isSuccess 规则(规范 §6)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Any, Dict, Optional
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class IpaynowResponse:
|
|
9
|
+
def __init__(self) -> None:
|
|
10
|
+
self._fields: Dict[str, str] = {}
|
|
11
|
+
self._raw_body: Optional[str] = None
|
|
12
|
+
|
|
13
|
+
def load(self, fields: Dict[str, str], raw_body: Optional[str] = None) -> None:
|
|
14
|
+
self._fields = dict(fields)
|
|
15
|
+
self._raw_body = raw_body
|
|
16
|
+
|
|
17
|
+
def get(self, name: str, default: Any = None) -> Any:
|
|
18
|
+
return self._fields.get(name, default)
|
|
19
|
+
|
|
20
|
+
def fields(self) -> Dict[str, str]:
|
|
21
|
+
return dict(self._fields)
|
|
22
|
+
|
|
23
|
+
def raw_body(self) -> Optional[str]:
|
|
24
|
+
return self._raw_body
|
|
25
|
+
|
|
26
|
+
def code(self) -> Optional[str]:
|
|
27
|
+
return self.get("responseCode")
|
|
28
|
+
|
|
29
|
+
def message(self) -> Optional[str]:
|
|
30
|
+
return self.get("responseMsg")
|
|
31
|
+
|
|
32
|
+
def is_success(self) -> bool:
|
|
33
|
+
return self.get("responseCode") == "A001"
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class UnifiedOrderResponse(IpaynowResponse):
|
|
37
|
+
def tn(self) -> Optional[str]:
|
|
38
|
+
value = self.get("tn")
|
|
39
|
+
return value if value is not None else self.get("TN")
|
|
40
|
+
|
|
41
|
+
def now_pay_order_no(self) -> Optional[str]:
|
|
42
|
+
return self.get("nowPayOrderNo")
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
class JsapiUnifiedOrderResponse(UnifiedOrderResponse):
|
|
46
|
+
pass
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
class AggregateCodeUnifiedOrderResponse(UnifiedOrderResponse):
|
|
50
|
+
pass
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
class MiniProgramUnifiedOrderResponse(UnifiedOrderResponse):
|
|
54
|
+
pass
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
class H5UnifiedOrderResponse(UnifiedOrderResponse):
|
|
58
|
+
pass
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
class AppUnifiedOrderResponse(UnifiedOrderResponse):
|
|
62
|
+
pass
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
class OrderQueryResponse(IpaynowResponse):
|
|
66
|
+
def trans_status(self) -> Optional[str]:
|
|
67
|
+
return self.get("transStatus")
|
|
68
|
+
|
|
69
|
+
def now_pay_order_no(self) -> Optional[str]:
|
|
70
|
+
return self.get("nowPayOrderNo")
|
|
71
|
+
|
|
72
|
+
def pay_time(self) -> Optional[str]:
|
|
73
|
+
return self.get("payTime")
|
|
74
|
+
|
|
75
|
+
def channel_order_no(self) -> Optional[str]:
|
|
76
|
+
return self.get("channelOrderNo")
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
class _RefundFamilyResponse(IpaynowResponse):
|
|
80
|
+
def is_success(self) -> bool:
|
|
81
|
+
return self.get("responseCode") == "R000"
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
class RefundResponse(_RefundFamilyResponse):
|
|
85
|
+
pass
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
class RefundQueryResponse(_RefundFamilyResponse):
|
|
89
|
+
pass
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
class ReverseResponse(_RefundFamilyResponse):
|
|
93
|
+
pass
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
class ReverseQueryResponse(_RefundFamilyResponse):
|
|
97
|
+
pass
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
class PaymentNotifyResponse(IpaynowResponse):
|
|
101
|
+
def is_success(self) -> bool:
|
|
102
|
+
return self.get("transStatus") == "A001"
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
class RefundNotifyResponse(IpaynowResponse):
|
|
106
|
+
def is_success(self) -> bool:
|
|
107
|
+
return self.get("tradeStatus") == "A001"
|
ipaynow_sdk/signer.py
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"""签名与验签(规范 §3、§4)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import base64
|
|
6
|
+
import hashlib
|
|
7
|
+
import hmac
|
|
8
|
+
from typing import Dict, Mapping
|
|
9
|
+
|
|
10
|
+
from cryptography.hazmat.primitives import hashes
|
|
11
|
+
from cryptography.hazmat.primitives.asymmetric import padding
|
|
12
|
+
|
|
13
|
+
from .config import IpaynowConfig, SignType
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
def _md5(value: str) -> str:
|
|
17
|
+
return hashlib.md5(value.encode("utf-8")).hexdigest()
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
def clean(params: Mapping[str, object]) -> Dict[str, str]:
|
|
21
|
+
"""剔除 None / 空串值,其余转为字符串。"""
|
|
22
|
+
return {
|
|
23
|
+
key: str(value)
|
|
24
|
+
for key, value in params.items()
|
|
25
|
+
if value is not None and value != ""
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
def sign(
|
|
30
|
+
params: Mapping[str, object],
|
|
31
|
+
config: IpaynowConfig,
|
|
32
|
+
exclude_sign_type: bool,
|
|
33
|
+
*signature_fields: str,
|
|
34
|
+
) -> str:
|
|
35
|
+
"""
|
|
36
|
+
1. 剔除 null/空串值
|
|
37
|
+
2. 剔除签名相关字段:mhtSignature、signature(以及调用方传入的额外字段)
|
|
38
|
+
3. excludeSignType=True 时再剔除 signType(mhtSignType 是不同字段名,永远参与签名)
|
|
39
|
+
4. 按 key 字典序升序拼接 k1=v1&k2=v2...
|
|
40
|
+
5. 追加 &md5(appKey) 后整体再 md5
|
|
41
|
+
"""
|
|
42
|
+
canonical = _canonical(params, exclude_sign_type, *signature_fields)
|
|
43
|
+
if config.sign_type is SignType.RSA:
|
|
44
|
+
signature = config.mch_private_key_object.sign(
|
|
45
|
+
canonical.encode("utf-8"),
|
|
46
|
+
padding.PKCS1v15(),
|
|
47
|
+
hashes.SHA256(),
|
|
48
|
+
)
|
|
49
|
+
return base64.b64encode(signature).decode()
|
|
50
|
+
return _md5(f"{canonical}&{_md5(config.app_key)}")
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def _canonical(
|
|
54
|
+
params: Mapping[str, object],
|
|
55
|
+
exclude_sign_type: bool,
|
|
56
|
+
*signature_fields: str,
|
|
57
|
+
) -> str:
|
|
58
|
+
cleaned = clean(params)
|
|
59
|
+
if exclude_sign_type:
|
|
60
|
+
cleaned.pop("signType", None)
|
|
61
|
+
cleaned.pop("mhtSignature", None)
|
|
62
|
+
cleaned.pop("signature", None)
|
|
63
|
+
for field in signature_fields:
|
|
64
|
+
cleaned.pop(field, None)
|
|
65
|
+
return "&".join(f"{key}={cleaned[key]}" for key in sorted(cleaned))
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
def verify(
|
|
69
|
+
fields: Mapping[str, object],
|
|
70
|
+
config: IpaynowConfig,
|
|
71
|
+
signature_field: str,
|
|
72
|
+
exclude_sign_type: bool,
|
|
73
|
+
) -> bool:
|
|
74
|
+
"""签名缺失一律返回 False(禁止跳过验签),常量时间比较实际值与期望值。"""
|
|
75
|
+
actual = fields.get(signature_field)
|
|
76
|
+
if not actual:
|
|
77
|
+
return False
|
|
78
|
+
actual_sign_type = fields.get("signType")
|
|
79
|
+
if actual_sign_type and str(actual_sign_type).upper() != config.sign_type.value:
|
|
80
|
+
return False
|
|
81
|
+
canonical = _canonical(fields, exclude_sign_type, signature_field, "mhtSignature")
|
|
82
|
+
if config.sign_type is SignType.RSA:
|
|
83
|
+
try:
|
|
84
|
+
config.ipaynow_public_key_object.verify(
|
|
85
|
+
base64.b64decode(str(actual), validate=True),
|
|
86
|
+
canonical.encode("utf-8"),
|
|
87
|
+
padding.PKCS1v15(),
|
|
88
|
+
hashes.SHA256(),
|
|
89
|
+
)
|
|
90
|
+
return True
|
|
91
|
+
except Exception: # noqa: BLE001
|
|
92
|
+
return False
|
|
93
|
+
expected = sign(fields, config, exclude_sign_type, signature_field, "mhtSignature")
|
|
94
|
+
return hmac.compare_digest(expected, str(actual).lower())
|
ipaynow_sdk/transport.py
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"""HTTP 传输层:标准库 urllib,零运行时依赖(规范 §1、§7)。"""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import socket
|
|
6
|
+
import urllib.error
|
|
7
|
+
import urllib.request
|
|
8
|
+
from typing import Dict, Protocol
|
|
9
|
+
from urllib.parse import urlencode
|
|
10
|
+
|
|
11
|
+
from .errors import IpaynowError, IpaynowErrorCode
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class HttpTransport(Protocol):
|
|
15
|
+
def post(self, url: str, params: Dict[str, str]) -> str: ...
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class UrllibHttpTransport:
|
|
19
|
+
"""默认传输实现。
|
|
20
|
+
|
|
21
|
+
urllib/socket 的超时是单一 socket 超时,无法像连接池型 HTTP 客户端那样
|
|
22
|
+
区分"建连超时"和"读超时"(Java 参考实现用 OkHttp 也遇到同样问题,靠消息
|
|
23
|
+
启发式区分)。这里用 read_timeout_ms 作为唯一的 socket 超时,超时一律归类
|
|
24
|
+
为 SOCKET_TIMEOUT —— 规范 §7 允许"尽力而为",需要注释说明。
|
|
25
|
+
"""
|
|
26
|
+
|
|
27
|
+
def __init__(self, connect_timeout_ms: int = 5000, read_timeout_ms: int = 15000) -> None:
|
|
28
|
+
self._connect_timeout_ms = connect_timeout_ms
|
|
29
|
+
self._timeout = read_timeout_ms / 1000.0
|
|
30
|
+
|
|
31
|
+
def post(self, url: str, params: Dict[str, str]) -> str:
|
|
32
|
+
funcode = params.get("funcode")
|
|
33
|
+
body = urlencode(params).encode("utf-8")
|
|
34
|
+
request = urllib.request.Request(
|
|
35
|
+
url,
|
|
36
|
+
data=body,
|
|
37
|
+
headers={"Content-Type": "application/x-www-form-urlencoded"},
|
|
38
|
+
method="POST",
|
|
39
|
+
)
|
|
40
|
+
try:
|
|
41
|
+
with urllib.request.urlopen(request, timeout=self._timeout) as response:
|
|
42
|
+
return response.read().decode("utf-8")
|
|
43
|
+
except urllib.error.HTTPError as e:
|
|
44
|
+
text = e.read().decode("utf-8", errors="replace")
|
|
45
|
+
raise IpaynowError(
|
|
46
|
+
IpaynowErrorCode.HTTP_EXCEPTION,
|
|
47
|
+
f"现在支付HTTP请求失败,状态码={e.code},功能码={funcode},响应报文={text}",
|
|
48
|
+
) from e
|
|
49
|
+
except (socket.timeout, TimeoutError) as e:
|
|
50
|
+
raise IpaynowError(
|
|
51
|
+
IpaynowErrorCode.SOCKET_TIMEOUT,
|
|
52
|
+
f"现在支付请求超时,功能码={funcode}",
|
|
53
|
+
) from e
|
|
54
|
+
except urllib.error.URLError as e:
|
|
55
|
+
if isinstance(e.reason, (socket.timeout, TimeoutError)):
|
|
56
|
+
raise IpaynowError(
|
|
57
|
+
IpaynowErrorCode.SOCKET_TIMEOUT,
|
|
58
|
+
f"现在支付请求超时,功能码={funcode}",
|
|
59
|
+
) from e
|
|
60
|
+
raise IpaynowError(
|
|
61
|
+
IpaynowErrorCode.HTTP_EXCEPTION,
|
|
62
|
+
f"现在支付请求异常,功能码={funcode},原因={e.reason}",
|
|
63
|
+
) from e
|