ipaynow-python-sdk 1.0.0__tar.gz

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.
@@ -0,0 +1,2 @@
1
+ prune tests
2
+ prune tests_live
@@ -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,184 @@
1
+ # iPayNow Python SDK
2
+
3
+ 现在支付 Python SDK,封装统一下单、订单查询、退款、撤销、回调验签,零运行时依赖(仅使用标准库)。
4
+
5
+ ## 环境要求
6
+
7
+ - Python 3.9+
8
+
9
+ ## 安装方式
10
+
11
+ ```bash
12
+ pip install ipaynow-python-sdk
13
+ ```
14
+
15
+ 包名为 `ipaynow-python-sdk`,导入名为 `ipaynow_sdk`。
16
+
17
+ ## 快速开始
18
+
19
+ ```python
20
+ from ipaynow_sdk import (
21
+ IpaynowClient,
22
+ IpaynowConfig,
23
+ H5UnifiedOrderParams,
24
+ H5UnifiedOrderRequest,
25
+ )
26
+
27
+ client = IpaynowClient(IpaynowConfig("appId", "appKey", "https://pay.ipaynow.cn"))
28
+
29
+ params = H5UnifiedOrderParams(
30
+ mhtOrderNo="ORDER202607030001",
31
+ mhtOrderName="测试订单",
32
+ mhtOrderDetail="测试订单",
33
+ mhtOrderAmt=1,
34
+ mhtOrderTimeOut=120,
35
+ mhtOrderStartTime="20260703120000",
36
+ notifyUrl="https://example.com/notify",
37
+ frontNotifyUrl="https://example.com/front",
38
+ payChannelType="12",
39
+ outputType="1",
40
+ consumerCreateIp="127.0.0.1",
41
+ )
42
+
43
+ response = client.execute(H5UnifiedOrderRequest(params))
44
+ if response.is_success():
45
+ tn = response.tn()
46
+ ```
47
+
48
+ ## 前端 Form 表单提交
49
+
50
+ 需要让浏览器直接向现在支付网关提交表单时,使用 `build_form_fields` 生成完整请求字段。入参与 `execute` 一致,SDK 不发起 HTTP 请求。
51
+
52
+ ```python
53
+ fields = client.build_form_fields(H5UnifiedOrderRequest(params))
54
+ ```
55
+
56
+ 返回字段包含业务参数、公共参数和签名字段,例如:
57
+
58
+ - `funcode`
59
+ - `version`
60
+ - `appId`
61
+ - `mhtCharset`
62
+ - `mhtSignType` 或 `signType`
63
+ - `mhtSignature`
64
+
65
+ 表单提交地址由请求路径决定:
66
+
67
+ ```python
68
+ action = client.config.endpoint(H5UnifiedOrderRequest(params).path)
69
+ ```
70
+
71
+ ## 支持接口
72
+
73
+ - `WP001`:统一下单(JSAPI / 聚合码 / 小程序 / H5 / APP)
74
+ - `MQ002`:订单查询
75
+ - `N001`:支付结果回调
76
+ - `R001`:退款
77
+ - `Q001`:退款查询
78
+ - `RN001`:退款结果回调
79
+ - `R002`:撤销
80
+ - `Q002`:撤销查询
81
+
82
+ 对应的 Params/Request/Response 类型:
83
+
84
+ | 场景 | Params | Request | Response |
85
+ | --- | --- | --- | --- |
86
+ | JSAPI 下单 | `JsapiUnifiedOrderParams` | `JsapiUnifiedOrderRequest` | `JsapiUnifiedOrderResponse` |
87
+ | 聚合码下单 | `AggregateCodeUnifiedOrderParams` | `AggregateCodeUnifiedOrderRequest` | `AggregateCodeUnifiedOrderResponse` |
88
+ | 小程序下单 | `MiniProgramUnifiedOrderParams` | `MiniProgramUnifiedOrderRequest` | `MiniProgramUnifiedOrderResponse` |
89
+ | H5 下单 | `H5UnifiedOrderParams` | `H5UnifiedOrderRequest` | `H5UnifiedOrderResponse` |
90
+ | APP 下单 | `AppUnifiedOrderParams` | `AppUnifiedOrderRequest` | `AppUnifiedOrderResponse` |
91
+ | 订单查询 | `OrderQueryParams` | `OrderQueryRequest` | `OrderQueryResponse` |
92
+ | 退款 | `RefundParams` | `RefundRequest` | `RefundResponse` |
93
+ | 退款查询 | `RefundQueryParams` | `RefundQueryRequest` | `RefundQueryResponse` |
94
+ | 撤销 | `ReverseParams` | `ReverseRequest` | `ReverseResponse` |
95
+ | 撤销查询 | `ReverseQueryParams` | `ReverseQueryRequest` | `ReverseQueryResponse` |
96
+ | 支付回调 | - | - | `PaymentNotifyResponse` |
97
+ | 退款回调 | - | - | `RefundNotifyResponse` |
98
+
99
+ ## 响应判断
100
+
101
+ - 正向同步接口(下单、订单查询)默认使用 `responseCode == "A001"` 判断成功(`IpaynowResponse.is_success()`)。
102
+ - 退款、撤销、退款查询、撤销查询使用 `responseCode == "R000"` 判断成功(`_RefundFamilyResponse.is_success()`)。
103
+ - 支付回调用 `transStatus == "A001"` 判断成功(`PaymentNotifyResponse.is_success()`)。
104
+ - 退款回调用 `tradeStatus == "A001"` 判断成功(`RefundNotifyResponse.is_success()`)。
105
+
106
+ 也可以直接读取原始字段:
107
+
108
+ ```python
109
+ code = response.code()
110
+ message = response.message()
111
+ raw_body = response.raw_body()
112
+ fields = response.fields()
113
+ value = response.get("someField")
114
+ ```
115
+
116
+ 统一下单响应还提供 `tn()` / `now_pay_order_no()`;订单查询响应提供 `trans_status()` / `now_pay_order_no()` / `pay_time()` / `channel_order_no()`。
117
+
118
+ ## 扩展字段
119
+
120
+ 每个 Params 类型都支持 `extra_params`(字典),会合并进 `to_map()` 的结果。SDK 只禁止覆盖公共签名字段,业务字段不做强校验,避免网关协议扩展时 SDK 阻塞接入。
121
+
122
+ ```python
123
+ params = H5UnifiedOrderParams(
124
+ mhtOrderNo="ORDER202607030001",
125
+ extra_params={"someNewField": "value"},
126
+ )
127
+ ```
128
+
129
+ 保留字段(`extra_params` 中若出现会抛出 `ValueError`):
130
+
131
+ - `funcode`
132
+ - `version`
133
+ - `appId`
134
+ - `mhtCharset`
135
+ - `mhtSignType`
136
+ - `signType`
137
+ - `mhtSignature`
138
+ - `signature`
139
+
140
+ ## 回调验签
141
+
142
+ ```python
143
+ from ipaynow_sdk import NotifyAck, NotifyParser
144
+
145
+ notify = NotifyParser.parse_payment(body, app_key)
146
+ if notify.is_success():
147
+ ack = NotifyAck.success()
148
+ else:
149
+ ack = NotifyAck.fail()
150
+ ```
151
+
152
+ 退款回调:
153
+
154
+ ```python
155
+ notify = NotifyParser.parse_refund(body, app_key)
156
+ ```
157
+
158
+ 验签失败时 `NotifyParser` 会抛出 `IpaynowError`(`code == IpaynowErrorCode.SIGN_ERROR`),而不是返回一个“失败”的响应对象,调用方需要用 `try/except` 包裹。
159
+
160
+ ## 错误处理
161
+
162
+ SDK 只抛出一种异常 `IpaynowError`,通过 `.code`(`IpaynowErrorCode` 枚举)判断具体失败类型:
163
+
164
+ ```python
165
+ from ipaynow_sdk import IpaynowError, IpaynowErrorCode
166
+
167
+ try:
168
+ response = client.execute(request)
169
+ except IpaynowError as e:
170
+ if e.code is IpaynowErrorCode.SIGN_ERROR:
171
+ ...
172
+ ```
173
+
174
+ 错误码表:
175
+
176
+ | 错误码 | 枚举 | 说明 |
177
+ | --- | --- | --- |
178
+ | `E0001` | `IpaynowErrorCode.SYSTEM_ERROR` | 组件内部异常 |
179
+ | `E0002` | `IpaynowErrorCode.HTTP_EXCEPTION` | HTTP 异常 |
180
+ | `E0003` | `IpaynowErrorCode.CONNECT_TIMEOUT` | 建连超时 |
181
+ | `E0004` | `IpaynowErrorCode.SOCKET_TIMEOUT` | 读超时 |
182
+ | `E0012` | `IpaynowErrorCode.SIGN_ERROR` | 渠道报文验签失败 |
183
+
184
+ 业务成功/失败(如余额不足、订单不存在)请从 `response.is_success()` / `response.code()` / `response.message()` 读取,不会以异常形式抛出。
@@ -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,19 @@
1
+ MANIFEST.in
2
+ README.md
3
+ pyproject.toml
4
+ ipaynow_python_sdk.egg-info/PKG-INFO
5
+ ipaynow_python_sdk.egg-info/SOURCES.txt
6
+ ipaynow_python_sdk.egg-info/dependency_links.txt
7
+ ipaynow_python_sdk.egg-info/requires.txt
8
+ ipaynow_python_sdk.egg-info/top_level.txt
9
+ ipaynow_sdk/__init__.py
10
+ ipaynow_sdk/client.py
11
+ ipaynow_sdk/config.py
12
+ ipaynow_sdk/errors.py
13
+ ipaynow_sdk/notify.py
14
+ ipaynow_sdk/params.py
15
+ ipaynow_sdk/parser.py
16
+ ipaynow_sdk/requests.py
17
+ ipaynow_sdk/responses.py
18
+ ipaynow_sdk/signer.py
19
+ ipaynow_sdk/transport.py
@@ -0,0 +1 @@
1
+ cryptography<46,>=45
@@ -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
+ ]