deepayment 0.1.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,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 DEEPayment
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,170 @@
1
+ Metadata-Version: 2.4
2
+ Name: deepayment
3
+ Version: 0.1.0
4
+ Summary: Merchant open API SDK (Ed25519 / RFC 9421 signing, X25519 sealed box body encryption)
5
+ Author-email: DEEPayment <support@deepayment.com>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/deepayment/sdk-python
8
+ Project-URL: Repository, https://github.com/deepayment/sdk-python
9
+ Project-URL: Issues, https://github.com/deepayment/sdk-python/issues
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Office/Business :: Financial
14
+ Requires-Python: >=3.10
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+ Requires-Dist: pynacl>=1.5
18
+ Provides-Extra: dev
19
+ Requires-Dist: pytest>=7; extra == "dev"
20
+ Dynamic: license-file
21
+
22
+ # DEEPayment SDK for Python
23
+
24
+ Python SDK for the merchant open API. Signing, digesting and body encryption are
25
+ handled by the SDK; merchants never assemble `Signature-Input`, `Content-Digest`
26
+ or the sealed box envelope themselves.
27
+
28
+ ## Protocol
29
+
30
+ [`protocol/`](protocol/) is the source of truth, shared with the Go / JavaScript /
31
+ PHP / Java SDKs through one set of test vectors:
32
+
33
+ | Item | Approach |
34
+ | --- | --- |
35
+ | Signature | Ed25519 + fixed RFC 9421 profile |
36
+ | Digest | RFC 9530 `Content-Digest` (sha-256) |
37
+ | POST body | X25519 sealed box envelope; the digest covers the sealed body |
38
+ | GET | No encryption, no body; only the public query and access key are signed |
39
+ | Webhook | Platform Ed25519 signature, plaintext body |
40
+ | Merchant identity | Located by `Merchant-Access-Key` only; signature params carry **no keyId** |
41
+
42
+ ## Installation
43
+
44
+ ```
45
+ pip install deepayment
46
+ ```
47
+
48
+ Runtime dependency: pynacl. Python 3.10 or newer.
49
+
50
+ ## Configuration
51
+
52
+ Six values; only the private key is generated on the merchant side, and the
53
+ platform never receives it:
54
+
55
+ | Field | Meaning |
56
+ | --- | --- |
57
+ | `base_url` | HTTPS platform origin, without `/api/v1` |
58
+ | `access_key` | Merchant access key issued by the platform |
59
+ | `merchant_private_key_base64` | Merchant Ed25519 private key, **kept on the merchant side only** |
60
+ | `platform_body_key_id` | Current platform body key id (per deployment) |
61
+ | `platform_body_public_key_base64` | Platform X25519 public key used to seal POST bodies |
62
+ | `platform_webhook_public_keys` | Platform webhook Ed25519 public keys, indexed by keyId |
63
+
64
+ `Client` rejects non-HTTPS base URLs. Synchronous responses remain plaintext JSON
65
+ and rely on HTTPS/TLS for confidentiality and integrity.
66
+
67
+ ## Quick start
68
+
69
+ ```python
70
+ from deepayment import APIError, Client, CreatePaymentReq, RequestError, ResponseError, TransportError
71
+
72
+ client = Client(
73
+ base_url="https://panama.deepayment.com", # production origin; no /api/v1
74
+ access_key="mak_live_xxx",
75
+ merchant_private_key_base64=merchant_private_key, # merchant Ed25519 private key, base64
76
+ platform_body_key_id="body_20260827_01",
77
+ platform_body_public_key_base64=platform_body_public_key, # platform X25519 public key, base64
78
+ platform_webhook_public_keys={ # keyId -> platform Ed25519 public key, base64
79
+ "pwhk_20260827_01": platform_webhook_public_key,
80
+ },
81
+ )
82
+
83
+ order = client.create_payment(CreatePaymentReq(
84
+ merchantOrderNo="M20260101001",
85
+ currency="BRL",
86
+ amount="100.00", # decimal string, never a float
87
+ paymentMethod={"code": "PIX", "pix": {"payerName": "Joao Silva"}},
88
+ webhookUrl="https://merchant.example/webhook/payments",
89
+ ))
90
+ print(order.orderNo, order.status, order.action.url)
91
+ ```
92
+
93
+ ### Two kinds of failure, opposite handling
94
+
95
+ | Error | Meaning | Handling |
96
+ | --- | --- | --- |
97
+ | `RequestError` | Rejected **before it was sent** (local validation, a bad parameter, or a request the SDK could not encode or sign) | Safe to mark failed; fix the request and retry under the same `merchantOrderNo` |
98
+ | `TransportError` | Handed to the transport, no usable response (connection failure, timeout, interrupted read) | Outcome unknown; **never mark a payout failed**. Query by `merchantOrderNo`, or resend the identical request under the same number |
99
+ | `APIError` | The gateway returned a business error (`msg` / `message` / `trace_id`) | Branch on `msg`. `IDEMPOTENCY_CONFLICT`: the number is already in flight, query it and keep querying rather than switching numbers. `CHANNEL_ERROR`: the order may already exist, query by `merchantOrderNo` first |
100
+ | `ResponseError` | The gateway or CDN returned something that is not an envelope (HTML 502, ...) | Outcome unknown; query before deciding |
101
+ | `ResponseTooLargeError` | A response arrived but exceeded the size limit and was discarded | Outcome unknown; the order was most likely created, query before deciding |
102
+ | Anything else | An unexpected error; assume the request may have arrived | Outcome unknown; query before deciding |
103
+
104
+ **`merchantOrderNo` is the only key that prevents a duplicate order.** A second
105
+ create with the same number never creates a second order: the platform answers
106
+ with the original order, or with `IDEMPOTENCY_CONFLICT` while the first one is
107
+ still being placed. The idempotency key travels with the request for tracing and
108
+ is **not** a deduplication key.
109
+
110
+ Two rules follow:
111
+
112
+ - After an unknown outcome, never allocate a new `merchantOrderNo`. Query the
113
+ existing one, or resend the same request under the same number.
114
+ - A resend must carry identical parameters. The platform returns the original
115
+ order without comparing fields, so a changed amount or account silently has no
116
+ effect. To change anything, use a new `merchantOrderNo` and reconcile the
117
+ original order first.
118
+
119
+ The SDK validates locally before signing (top-level required fields and formats,
120
+ method shape and required extras); the rules are defined in
121
+ [`protocol/merchant-api.md`](protocol/merchant-api.md#client-side-validation).
122
+ Format checks (phone length, e-mail, ...) stay with the gateway on purpose so the
123
+ SDK cannot drift from it.
124
+
125
+ ### Next steps
126
+
127
+ Queries, idempotent retries and webhook verification are covered by the platform
128
+ documentation at <https://docs.deepayment.com>; its examples map one to one onto this
129
+ SDK. The wire protocol is in
130
+ [`protocol/webhook.md`](protocol/webhook.md) and
131
+ [`protocol/merchant-api.md`](protocol/merchant-api.md). Key points:
132
+
133
+ - After a create timeout, query by `merchantOrderNo` first instead of sending a
134
+ new order; a deliberate retry repeats the same call with the same `merchantOrderNo`.
135
+ - For webhooks, pass the method, path, headers and the **raw, unparsed body bytes**
136
+ to `client.parse_payment_webhook(method=, path=, headers=, body=)`; the SDK checks
137
+ the digest, event id, time window and Ed25519 signature. Return 2xx once processed
138
+ and deduplicate by `eventId`.
139
+
140
+ ## Amounts
141
+
142
+ Amounts, fees and rates in requests, responses, webhooks, balances, rates and
143
+ receipts are **always decimal strings** such as `"100.00"`. Never use floats.
144
+
145
+ ## Order status
146
+
147
+ There are exactly six external statuses: `PENDING` `PROCESSING` `SUCCEEDED`
148
+ `FAILED` `EXPIRED` `CANCELED`.
149
+
150
+ ## Troubleshooting
151
+
152
+ | Situation | Action |
153
+ | --- | --- |
154
+ | Create request timed out | Query by `merchantOrderNo`; do not send a new order |
155
+ | Deliberate retry | Call the same method again with the same `merchantOrderNo` and identical parameters; the SDK regenerates the nonce on every request |
156
+ | Signature rejected | Check the server clock, the access key, and that the merchant private key matches the public key registered with the platform |
157
+ | Body decryption failed | Check that `platform_body_key_id` and the public key belong to the current environment |
158
+ | Webhook signature rejected | Check that the webhook key set contains the `keyid` from the header |
159
+
160
+ ## Tests
161
+
162
+ ```
163
+ python -m pip install -e '.[dev]'
164
+ python -m pytest -q
165
+ ```
166
+
167
+ The tests assert directly against the [`protocol/testdata`](protocol/testdata/)
168
+ vectors: `Signature-Input`, the signature base and the signature value are compared
169
+ byte for byte, and body encryption is verified by opening ciphertext produced by
170
+ the reference implementation.
@@ -0,0 +1,149 @@
1
+ # DEEPayment SDK for Python
2
+
3
+ Python SDK for the merchant open API. Signing, digesting and body encryption are
4
+ handled by the SDK; merchants never assemble `Signature-Input`, `Content-Digest`
5
+ or the sealed box envelope themselves.
6
+
7
+ ## Protocol
8
+
9
+ [`protocol/`](protocol/) is the source of truth, shared with the Go / JavaScript /
10
+ PHP / Java SDKs through one set of test vectors:
11
+
12
+ | Item | Approach |
13
+ | --- | --- |
14
+ | Signature | Ed25519 + fixed RFC 9421 profile |
15
+ | Digest | RFC 9530 `Content-Digest` (sha-256) |
16
+ | POST body | X25519 sealed box envelope; the digest covers the sealed body |
17
+ | GET | No encryption, no body; only the public query and access key are signed |
18
+ | Webhook | Platform Ed25519 signature, plaintext body |
19
+ | Merchant identity | Located by `Merchant-Access-Key` only; signature params carry **no keyId** |
20
+
21
+ ## Installation
22
+
23
+ ```
24
+ pip install deepayment
25
+ ```
26
+
27
+ Runtime dependency: pynacl. Python 3.10 or newer.
28
+
29
+ ## Configuration
30
+
31
+ Six values; only the private key is generated on the merchant side, and the
32
+ platform never receives it:
33
+
34
+ | Field | Meaning |
35
+ | --- | --- |
36
+ | `base_url` | HTTPS platform origin, without `/api/v1` |
37
+ | `access_key` | Merchant access key issued by the platform |
38
+ | `merchant_private_key_base64` | Merchant Ed25519 private key, **kept on the merchant side only** |
39
+ | `platform_body_key_id` | Current platform body key id (per deployment) |
40
+ | `platform_body_public_key_base64` | Platform X25519 public key used to seal POST bodies |
41
+ | `platform_webhook_public_keys` | Platform webhook Ed25519 public keys, indexed by keyId |
42
+
43
+ `Client` rejects non-HTTPS base URLs. Synchronous responses remain plaintext JSON
44
+ and rely on HTTPS/TLS for confidentiality and integrity.
45
+
46
+ ## Quick start
47
+
48
+ ```python
49
+ from deepayment import APIError, Client, CreatePaymentReq, RequestError, ResponseError, TransportError
50
+
51
+ client = Client(
52
+ base_url="https://panama.deepayment.com", # production origin; no /api/v1
53
+ access_key="mak_live_xxx",
54
+ merchant_private_key_base64=merchant_private_key, # merchant Ed25519 private key, base64
55
+ platform_body_key_id="body_20260827_01",
56
+ platform_body_public_key_base64=platform_body_public_key, # platform X25519 public key, base64
57
+ platform_webhook_public_keys={ # keyId -> platform Ed25519 public key, base64
58
+ "pwhk_20260827_01": platform_webhook_public_key,
59
+ },
60
+ )
61
+
62
+ order = client.create_payment(CreatePaymentReq(
63
+ merchantOrderNo="M20260101001",
64
+ currency="BRL",
65
+ amount="100.00", # decimal string, never a float
66
+ paymentMethod={"code": "PIX", "pix": {"payerName": "Joao Silva"}},
67
+ webhookUrl="https://merchant.example/webhook/payments",
68
+ ))
69
+ print(order.orderNo, order.status, order.action.url)
70
+ ```
71
+
72
+ ### Two kinds of failure, opposite handling
73
+
74
+ | Error | Meaning | Handling |
75
+ | --- | --- | --- |
76
+ | `RequestError` | Rejected **before it was sent** (local validation, a bad parameter, or a request the SDK could not encode or sign) | Safe to mark failed; fix the request and retry under the same `merchantOrderNo` |
77
+ | `TransportError` | Handed to the transport, no usable response (connection failure, timeout, interrupted read) | Outcome unknown; **never mark a payout failed**. Query by `merchantOrderNo`, or resend the identical request under the same number |
78
+ | `APIError` | The gateway returned a business error (`msg` / `message` / `trace_id`) | Branch on `msg`. `IDEMPOTENCY_CONFLICT`: the number is already in flight, query it and keep querying rather than switching numbers. `CHANNEL_ERROR`: the order may already exist, query by `merchantOrderNo` first |
79
+ | `ResponseError` | The gateway or CDN returned something that is not an envelope (HTML 502, ...) | Outcome unknown; query before deciding |
80
+ | `ResponseTooLargeError` | A response arrived but exceeded the size limit and was discarded | Outcome unknown; the order was most likely created, query before deciding |
81
+ | Anything else | An unexpected error; assume the request may have arrived | Outcome unknown; query before deciding |
82
+
83
+ **`merchantOrderNo` is the only key that prevents a duplicate order.** A second
84
+ create with the same number never creates a second order: the platform answers
85
+ with the original order, or with `IDEMPOTENCY_CONFLICT` while the first one is
86
+ still being placed. The idempotency key travels with the request for tracing and
87
+ is **not** a deduplication key.
88
+
89
+ Two rules follow:
90
+
91
+ - After an unknown outcome, never allocate a new `merchantOrderNo`. Query the
92
+ existing one, or resend the same request under the same number.
93
+ - A resend must carry identical parameters. The platform returns the original
94
+ order without comparing fields, so a changed amount or account silently has no
95
+ effect. To change anything, use a new `merchantOrderNo` and reconcile the
96
+ original order first.
97
+
98
+ The SDK validates locally before signing (top-level required fields and formats,
99
+ method shape and required extras); the rules are defined in
100
+ [`protocol/merchant-api.md`](protocol/merchant-api.md#client-side-validation).
101
+ Format checks (phone length, e-mail, ...) stay with the gateway on purpose so the
102
+ SDK cannot drift from it.
103
+
104
+ ### Next steps
105
+
106
+ Queries, idempotent retries and webhook verification are covered by the platform
107
+ documentation at <https://docs.deepayment.com>; its examples map one to one onto this
108
+ SDK. The wire protocol is in
109
+ [`protocol/webhook.md`](protocol/webhook.md) and
110
+ [`protocol/merchant-api.md`](protocol/merchant-api.md). Key points:
111
+
112
+ - After a create timeout, query by `merchantOrderNo` first instead of sending a
113
+ new order; a deliberate retry repeats the same call with the same `merchantOrderNo`.
114
+ - For webhooks, pass the method, path, headers and the **raw, unparsed body bytes**
115
+ to `client.parse_payment_webhook(method=, path=, headers=, body=)`; the SDK checks
116
+ the digest, event id, time window and Ed25519 signature. Return 2xx once processed
117
+ and deduplicate by `eventId`.
118
+
119
+ ## Amounts
120
+
121
+ Amounts, fees and rates in requests, responses, webhooks, balances, rates and
122
+ receipts are **always decimal strings** such as `"100.00"`. Never use floats.
123
+
124
+ ## Order status
125
+
126
+ There are exactly six external statuses: `PENDING` `PROCESSING` `SUCCEEDED`
127
+ `FAILED` `EXPIRED` `CANCELED`.
128
+
129
+ ## Troubleshooting
130
+
131
+ | Situation | Action |
132
+ | --- | --- |
133
+ | Create request timed out | Query by `merchantOrderNo`; do not send a new order |
134
+ | Deliberate retry | Call the same method again with the same `merchantOrderNo` and identical parameters; the SDK regenerates the nonce on every request |
135
+ | Signature rejected | Check the server clock, the access key, and that the merchant private key matches the public key registered with the platform |
136
+ | Body decryption failed | Check that `platform_body_key_id` and the public key belong to the current environment |
137
+ | Webhook signature rejected | Check that the webhook key set contains the `keyid` from the header |
138
+
139
+ ## Tests
140
+
141
+ ```
142
+ python -m pip install -e '.[dev]'
143
+ python -m pytest -q
144
+ ```
145
+
146
+ The tests assert directly against the [`protocol/testdata`](protocol/testdata/)
147
+ vectors: `Signature-Input`, the signature base and the signature value are compared
148
+ byte for byte, and body encryption is verified by opening ciphertext produced by
149
+ the reference implementation.
@@ -0,0 +1,52 @@
1
+ """Python SDK for the merchant open API.
2
+
3
+ Only business methods, DTOs, webhook verification and error types are public.
4
+ Signing, digest and body envelope internals live in _protocol / _request and
5
+ are not exported.
6
+ """
7
+
8
+ from .client import Client
9
+ from .errors import (
10
+ APIError,
11
+ ConfigError,
12
+ RequestError,
13
+ ResponseError,
14
+ ResponseTooLargeError,
15
+ SDKError,
16
+ TransportError,
17
+ WebhookError,
18
+ )
19
+ from .types import (
20
+ Balance,
21
+ CreatePaymentReq,
22
+ CreatePayoutReq,
23
+ EXTERNAL_STATUSES,
24
+ Failure,
25
+ OrderAction,
26
+ PaymentOrder,
27
+ PaymentWebhook,
28
+ PayoutOrder,
29
+ PayoutReceipt,
30
+ PayoutWebhook,
31
+ STATUS_CANCELED,
32
+ STATUS_EXPIRED,
33
+ STATUS_FAILED,
34
+ STATUS_PENDING,
35
+ STATUS_PROCESSING,
36
+ STATUS_SUCCEEDED,
37
+ USDRate,
38
+ )
39
+
40
+ __version__ = "0.1.0"
41
+
42
+ __all__ = [
43
+ "Client",
44
+ "CreatePaymentReq", "CreatePayoutReq",
45
+ "PaymentOrder", "PayoutOrder", "PayoutReceipt", "Balance", "USDRate",
46
+ "PaymentWebhook", "PayoutWebhook", "OrderAction", "Failure",
47
+ "SDKError", "ConfigError", "RequestError", "APIError",
48
+ "ResponseError", "ResponseTooLargeError", "TransportError", "WebhookError",
49
+ "STATUS_PENDING", "STATUS_PROCESSING", "STATUS_SUCCEEDED",
50
+ "STATUS_FAILED", "STATUS_EXPIRED", "STATUS_CANCELED", "EXTERNAL_STATUSES",
51
+ "__version__",
52
+ ]