timbro-payments 0.10.0__tar.gz

timbro_payments-0.10.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

timbro_payments-0.10.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: timbro-payments
+Version: 0.10.0
+Summary: Python SDK for Timbro Payments: payments, refunds, merchant accounts, webhook endpoints, and signed webhooks
+Author: Timbro contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://timbro.do
+Project-URL: Source, https://github.com/indexa-labs/checkout/tree/main/python/timbro-payments
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: timbro-protocol<0.11,>=0.10
+Requires-Dist: httpx<1,>=0.27
+Dynamic: license-file
+
+# timbro-payments
+
+The Python SDK for Timbro Payments: create payments and refunds, read merchant accounts, manage webhook endpoints, and verify signed webhooks. It needs Python 3.11 or newer and depends only on `httpx` and `timbro-protocol`.
+
+```sh
+pip install timbro-payments
+```
+
+## Take a payment
+
+```python
+from timbro_payments import TimbroPayments, payment_reference_for_source
+
+with TimbroPayments(api_key=secret_key, application="my-erp/1.0") as timbro:
+    payment = timbro.payments.create({
+        "paymentReference": payment_reference_for_source({"id": "order-123", "version": "1"}),
+        "amount": {"currency": "DOP", "value": "1250.00"},
+        "description": "Servicio",
+        "tax": {"includedAmount": "190.68"},
+    })
+    redirect_to(payment["checkout"]["url"])
+
+    payment = timbro.payments.retrieve(payment["id"])
+    for refund in timbro.refunds.list_all(payment_id=payment["id"]):
+        ...
+```
+
+Requests and responses are plain dictionaries with the API's camelCase keys, typed as `TypedDict`s in `timbro_payments.types`. Money is a decimal string. Fields and enum values added by a later API version pass through unchanged. A declined payment is a `Payment` with `status: "declined"`, not an error.
+
+`AsyncTimbroPayments` has the same namespaces: `await` each call and use `async for` with `list_all`.
+
+`timbro.mode` is `"test"` for an `sk_test_` key, `"live"` for an `sk_live_` key, and `None` for any other key form, so an integration can show which mode it is configured for without a call.
+
+| Namespace | Methods |
+| --- | --- |
+| `payments` | `create`, `retrieve`, `list`, `list_all`, `cancel`, `create_invoice`, `attach_invoice`, `update_invoice_choice`, `update_invoice_recipient` |
+| `refunds` | `create`, `retrieve`, `list`, `list_all`, `attach_invoice` |
+| `merchant_accounts` | `retrieve`, `list`, `list_all` |
+| `webhook_endpoints` | `create`, `retrieve`, `list`, `list_all`, `delete`, `suspend`, `reactivate`, `rotate_secret`, `list_deliveries`, `list_all_deliveries`, `replay` |
+| `business` | `retrieve`, `update`, `configure_invoicing`, `import_signing_certificate`, `issue_test_invoice`, `issue_invoice_key`, `checkout_policy.retrieve`, `checkout_policy.update` |
+| `merchant_onboarding` | `verify_rnc` |
+| `api_keys` | `rotate` |
+
+Path identifiers are positional, the request body is the positional `request`, and filters and options are keyword-only.
+
+## Retries and idempotency
+
+The client retries at most twice (`max_retries=2`) after `408`, `429`, `500`, `502`, `503`, `504`, and connection failures. It waits 0.1 seconds, then 0.2, and honors a `Retry-After` of up to two seconds; a longer `Retry-After` ends the call with `retry_after_seconds` set. Reads and other operations the contract marks safe always retry. Other writes retry only with an idempotency key.
+
+`payments.create`, `payments.cancel`, `payments.create_invoice`, `payments.attach_invoice`, `refunds.create`, and `refunds.attach_invoice` derive their idempotency key from the payment reference, the payment, the refund reference, or the attached Invoice and its payment or refund, so repeating a call is safe. Other writes that need a key take `idempotency_key=` and require it. Derive that key from your durable record of the command, such as the order line it serves, and send the same key on every retry and replay. Never generate a random key per attempt: an ERP that replays a transaction would then run the command twice. An explicit key always wins.
+
+## Timeouts
+
+`timeout` (30 seconds by default) limits each phase of one attempt separately: waiting for a pooled connection, connecting, writing, and each wait for response bytes. When Timbro stops answering, an attempt ends after `timeout`, and a call makes at most `max_retries + 1` attempts with up to two seconds between them. A stalled call therefore lasts about `(max_retries + 1) * timeout` plus four seconds: about 94 seconds with the defaults. Slow connects and writes can add their own phase limits on top. There is no overall deadline. A worker bound to a request, such as an Odoo worker with a 120-second limit, should pass smaller values, for example `TimbroPayments(api_key=key, timeout=10, max_retries=1)`, which bounds a call near 22 seconds. A call can also pass `timeout=` to override the default for that call.
+
+`httpx` logs each request URL, including the references in a list filter, at `INFO` on the `httpx` logger. Raise that logger's level to keep them out of your logs:
+
+```python
+import logging
+
+logging.getLogger("httpx").setLevel(logging.WARNING)
+```
+
+With your own `http_client`, that client's timeout applies unless a call passes `timeout=`. `httpx` finds CA certificates through `SSL_CERT_FILE` and `SSL_CERT_DIR`; it does not read `REQUESTS_CA_BUNDLE`. A host behind TLS inspection passes an `http_client` built with its CA bundle, such as `httpx.Client(verify=ssl_context)`.
+
+## Errors
+
+Every error is a `TimbroError` with `code`, `message`, `request_id`, `operation`, `method`, `retryable`, `outcome_unknown`, `recovery`, and `recovery_method`. `operation` and `recovery` are contract operation IDs, such as `createPayment`; `method` and `recovery_method` are the SDK methods that send them, such as `payments.create` and `payments.list`. The text never contains the API key, a request body, a header, or a Checkout URL. Errors can be pickled, so a job queue can carry them.
+
+`timbro-payments` and `timbro-invoices` raise the same classes from `timbro-protocol`, so one `except TimbroError` handles both. To treat one package's calls differently, branch on `method` or `operation`:
+
+```python
+from timbro_payments import TimbroError
+
+try:
+    timbro.payments.cancel(payment["id"])
+except TimbroError as error:
+    if error.method == "payments.cancel" and error.code == "payment_cancel_not_allowed":
+        payment = timbro.payments.retrieve(payment["id"])
+    else:
+        raise
+```
+
+| Error | When |
+| --- | --- |
+| `InvalidRequestError` | 400 or 422; `problems` lists each field at fault |
+| `AuthenticationError` | 401 |
+| `PermissionDeniedError` | 403, such as a key without the needed grant |
+| `NotFoundError` | 404 |
+| `ConflictError` | 409 |
+| `RateLimitError` | 429; see `retry_after_seconds` |
+| `ServerError` | 5xx |
+| `APIError` | Any other failure status, and the base of the classes above |
+| `APIConnectionError`, `APITimeoutError` | No response arrived; `code` says what that means, below |
+| `UnexpectedResponseError` | A response outside the published contract, including a redirect, or one that names another resource than the one a read or an action addressed (`response_identity_mismatch`) |
+
+When no response arrives, `code` separates three cases:
+
+| `code` | Meaning |
+| --- | --- |
+| `connection_failed` | The request never left, or a read broke off. Nothing changed at Timbro. |
+| `request_timed_out` | A read timed out. Nothing changed at Timbro. |
+| `outcome_unknown` | A write may have reached Timbro. `outcome_unknown` is true. |
+
+`@timbro/payments` reports all three as `transport_failure` with `status` 0, and does not say whether a write may have run.
+
+When `outcome_unknown` is true, a write may have taken effect even though the call failed: an earlier attempt or the last one reached Timbro and got no final answer. The error text says what to do next. Repeat the call with the same idempotency key, or find the result with the recovery method. `payments.create` recovers with `payments.list(payment_reference=...)` and `refunds.create` with `refunds.list(payment_id=..., refund_reference=...)`, so a lost create is found without its ID.
+
+## Routes outside the published contract
+
+Prefer the typed methods. For a route the published contract does not include yet, such as a Stamp installation's own readiness read, `request` sends one call through the same client, with the same API key, user agent, redirect refusal, 10 MiB limit, and errors:
+
+```python
+readiness = timbro.request("GET", "/v1/stamp/readiness")
+```
+
+`path` must be a `/v1/` path; an absolute URL, a query or fragment in the path, and an empty or dot segment raise `ValueError`, and `query=` carries the filters. The answer is the decoded JSON object, or `None` for an empty one, and nothing checks its shape. A `GET` is retried when safe; any other method is retried only when you pass `idempotency_key=`. An error it raises has `method` `"request"`, `operation` set to the method and path, such as `"GET /v1/stamp/readiness"`, and no recovery. ``AsyncTimbroPayments`` clients have the same method to `await`.
+
+## Webhooks
+
+Verification needs no API key:
+
+```python
+from timbro_payments import webhooks
+
+event = webhooks.verify(body=raw_body, headers=request_headers, secret=webhook_secret)
+inbox.store(event)  # Deduplicate by event["id"], then acknowledge.
+
+if webhooks.is_known_event(event) and event["type"] == "payment.succeeded":
+    payment = timbro.payments.retrieve(event["data"]["id"])
+```
+
+Pass the raw body bytes and every secret that is valid during a rotation. Events of a type this version does not know verify and return as `UnknownWebhookEvent`. A failure raises `WebhookVerificationError`, whose `reason` names the check.
+
+## Testing
+
+`timbro_payments.testing` builds schema-valid resources and signs webhook fixtures. `testing.payment(status)` and `testing.refund(status)` fill the members each status carries: a `succeeded` Payment has `capturedPayment` allocations that sum to `totalAmount` and no `nextAction`, and a `declined` Refund has its `decline`. A create must answer with the identity it sent, so a fake create passes it back as an override. `testing.api_error(status, code, method="payments.cancel")` builds the `APIError` subclass that method raises for that status. Fake the API by giving the client an `httpx.MockTransport`:
+
+```python
+import json
+
+import httpx
+from timbro_payments import TimbroPayments, testing
+
+def handler(request: httpx.Request) -> httpx.Response:
+    sent = json.loads(request.content)
+    payment = testing.payment("succeeded", paymentReference=sent["paymentReference"])
+    return httpx.Response(201, json=payment)
+
+timbro = TimbroPayments(
+    api_key="sk_test_123",
+    http_client=httpx.Client(transport=httpx.MockTransport(handler)),
+)
+
+body = b'{"id":"event_...","type":"payment.succeeded"}'
+headers = testing.sign_webhook(body, "whsec_...", webhook_id="event_...")
+```
+
+## License
+
+No license has been granted for this package yet. The license will be declared before the first public release.

timbro_payments-0.10.0/README.md

@@ -0,0 +1,161 @@
+# timbro-payments
+
+The Python SDK for Timbro Payments: create payments and refunds, read merchant accounts, manage webhook endpoints, and verify signed webhooks. It needs Python 3.11 or newer and depends only on `httpx` and `timbro-protocol`.
+
+```sh
+pip install timbro-payments
+```
+
+## Take a payment
+
+```python
+from timbro_payments import TimbroPayments, payment_reference_for_source
+
+with TimbroPayments(api_key=secret_key, application="my-erp/1.0") as timbro:
+    payment = timbro.payments.create({
+        "paymentReference": payment_reference_for_source({"id": "order-123", "version": "1"}),
+        "amount": {"currency": "DOP", "value": "1250.00"},
+        "description": "Servicio",
+        "tax": {"includedAmount": "190.68"},
+    })
+    redirect_to(payment["checkout"]["url"])
+
+    payment = timbro.payments.retrieve(payment["id"])
+    for refund in timbro.refunds.list_all(payment_id=payment["id"]):
+        ...
+```
+
+Requests and responses are plain dictionaries with the API's camelCase keys, typed as `TypedDict`s in `timbro_payments.types`. Money is a decimal string. Fields and enum values added by a later API version pass through unchanged. A declined payment is a `Payment` with `status: "declined"`, not an error.
+
+`AsyncTimbroPayments` has the same namespaces: `await` each call and use `async for` with `list_all`.
+
+`timbro.mode` is `"test"` for an `sk_test_` key, `"live"` for an `sk_live_` key, and `None` for any other key form, so an integration can show which mode it is configured for without a call.
+
+| Namespace | Methods |
+| --- | --- |
+| `payments` | `create`, `retrieve`, `list`, `list_all`, `cancel`, `create_invoice`, `attach_invoice`, `update_invoice_choice`, `update_invoice_recipient` |
+| `refunds` | `create`, `retrieve`, `list`, `list_all`, `attach_invoice` |
+| `merchant_accounts` | `retrieve`, `list`, `list_all` |
+| `webhook_endpoints` | `create`, `retrieve`, `list`, `list_all`, `delete`, `suspend`, `reactivate`, `rotate_secret`, `list_deliveries`, `list_all_deliveries`, `replay` |
+| `business` | `retrieve`, `update`, `configure_invoicing`, `import_signing_certificate`, `issue_test_invoice`, `issue_invoice_key`, `checkout_policy.retrieve`, `checkout_policy.update` |
+| `merchant_onboarding` | `verify_rnc` |
+| `api_keys` | `rotate` |
+
+Path identifiers are positional, the request body is the positional `request`, and filters and options are keyword-only.
+
+## Retries and idempotency
+
+The client retries at most twice (`max_retries=2`) after `408`, `429`, `500`, `502`, `503`, `504`, and connection failures. It waits 0.1 seconds, then 0.2, and honors a `Retry-After` of up to two seconds; a longer `Retry-After` ends the call with `retry_after_seconds` set. Reads and other operations the contract marks safe always retry. Other writes retry only with an idempotency key.
+
+`payments.create`, `payments.cancel`, `payments.create_invoice`, `payments.attach_invoice`, `refunds.create`, and `refunds.attach_invoice` derive their idempotency key from the payment reference, the payment, the refund reference, or the attached Invoice and its payment or refund, so repeating a call is safe. Other writes that need a key take `idempotency_key=` and require it. Derive that key from your durable record of the command, such as the order line it serves, and send the same key on every retry and replay. Never generate a random key per attempt: an ERP that replays a transaction would then run the command twice. An explicit key always wins.
+
+## Timeouts
+
+`timeout` (30 seconds by default) limits each phase of one attempt separately: waiting for a pooled connection, connecting, writing, and each wait for response bytes. When Timbro stops answering, an attempt ends after `timeout`, and a call makes at most `max_retries + 1` attempts with up to two seconds between them. A stalled call therefore lasts about `(max_retries + 1) * timeout` plus four seconds: about 94 seconds with the defaults. Slow connects and writes can add their own phase limits on top. There is no overall deadline. A worker bound to a request, such as an Odoo worker with a 120-second limit, should pass smaller values, for example `TimbroPayments(api_key=key, timeout=10, max_retries=1)`, which bounds a call near 22 seconds. A call can also pass `timeout=` to override the default for that call.
+
+`httpx` logs each request URL, including the references in a list filter, at `INFO` on the `httpx` logger. Raise that logger's level to keep them out of your logs:
+
+```python
+import logging
+
+logging.getLogger("httpx").setLevel(logging.WARNING)
+```
+
+With your own `http_client`, that client's timeout applies unless a call passes `timeout=`. `httpx` finds CA certificates through `SSL_CERT_FILE` and `SSL_CERT_DIR`; it does not read `REQUESTS_CA_BUNDLE`. A host behind TLS inspection passes an `http_client` built with its CA bundle, such as `httpx.Client(verify=ssl_context)`.
+
+## Errors
+
+Every error is a `TimbroError` with `code`, `message`, `request_id`, `operation`, `method`, `retryable`, `outcome_unknown`, `recovery`, and `recovery_method`. `operation` and `recovery` are contract operation IDs, such as `createPayment`; `method` and `recovery_method` are the SDK methods that send them, such as `payments.create` and `payments.list`. The text never contains the API key, a request body, a header, or a Checkout URL. Errors can be pickled, so a job queue can carry them.
+
+`timbro-payments` and `timbro-invoices` raise the same classes from `timbro-protocol`, so one `except TimbroError` handles both. To treat one package's calls differently, branch on `method` or `operation`:
+
+```python
+from timbro_payments import TimbroError
+
+try:
+    timbro.payments.cancel(payment["id"])
+except TimbroError as error:
+    if error.method == "payments.cancel" and error.code == "payment_cancel_not_allowed":
+        payment = timbro.payments.retrieve(payment["id"])
+    else:
+        raise
+```
+
+| Error | When |
+| --- | --- |
+| `InvalidRequestError` | 400 or 422; `problems` lists each field at fault |
+| `AuthenticationError` | 401 |
+| `PermissionDeniedError` | 403, such as a key without the needed grant |
+| `NotFoundError` | 404 |
+| `ConflictError` | 409 |
+| `RateLimitError` | 429; see `retry_after_seconds` |
+| `ServerError` | 5xx |
+| `APIError` | Any other failure status, and the base of the classes above |
+| `APIConnectionError`, `APITimeoutError` | No response arrived; `code` says what that means, below |
+| `UnexpectedResponseError` | A response outside the published contract, including a redirect, or one that names another resource than the one a read or an action addressed (`response_identity_mismatch`) |
+
+When no response arrives, `code` separates three cases:
+
+| `code` | Meaning |
+| --- | --- |
+| `connection_failed` | The request never left, or a read broke off. Nothing changed at Timbro. |
+| `request_timed_out` | A read timed out. Nothing changed at Timbro. |
+| `outcome_unknown` | A write may have reached Timbro. `outcome_unknown` is true. |
+
+`@timbro/payments` reports all three as `transport_failure` with `status` 0, and does not say whether a write may have run.
+
+When `outcome_unknown` is true, a write may have taken effect even though the call failed: an earlier attempt or the last one reached Timbro and got no final answer. The error text says what to do next. Repeat the call with the same idempotency key, or find the result with the recovery method. `payments.create` recovers with `payments.list(payment_reference=...)` and `refunds.create` with `refunds.list(payment_id=..., refund_reference=...)`, so a lost create is found without its ID.
+
+## Routes outside the published contract
+
+Prefer the typed methods. For a route the published contract does not include yet, such as a Stamp installation's own readiness read, `request` sends one call through the same client, with the same API key, user agent, redirect refusal, 10 MiB limit, and errors:
+
+```python
+readiness = timbro.request("GET", "/v1/stamp/readiness")
+```
+
+`path` must be a `/v1/` path; an absolute URL, a query or fragment in the path, and an empty or dot segment raise `ValueError`, and `query=` carries the filters. The answer is the decoded JSON object, or `None` for an empty one, and nothing checks its shape. A `GET` is retried when safe; any other method is retried only when you pass `idempotency_key=`. An error it raises has `method` `"request"`, `operation` set to the method and path, such as `"GET /v1/stamp/readiness"`, and no recovery. ``AsyncTimbroPayments`` clients have the same method to `await`.
+
+## Webhooks
+
+Verification needs no API key:
+
+```python
+from timbro_payments import webhooks
+
+event = webhooks.verify(body=raw_body, headers=request_headers, secret=webhook_secret)
+inbox.store(event)  # Deduplicate by event["id"], then acknowledge.
+
+if webhooks.is_known_event(event) and event["type"] == "payment.succeeded":
+    payment = timbro.payments.retrieve(event["data"]["id"])
+```
+
+Pass the raw body bytes and every secret that is valid during a rotation. Events of a type this version does not know verify and return as `UnknownWebhookEvent`. A failure raises `WebhookVerificationError`, whose `reason` names the check.
+
+## Testing
+
+`timbro_payments.testing` builds schema-valid resources and signs webhook fixtures. `testing.payment(status)` and `testing.refund(status)` fill the members each status carries: a `succeeded` Payment has `capturedPayment` allocations that sum to `totalAmount` and no `nextAction`, and a `declined` Refund has its `decline`. A create must answer with the identity it sent, so a fake create passes it back as an override. `testing.api_error(status, code, method="payments.cancel")` builds the `APIError` subclass that method raises for that status. Fake the API by giving the client an `httpx.MockTransport`:
+
+```python
+import json
+
+import httpx
+from timbro_payments import TimbroPayments, testing
+
+def handler(request: httpx.Request) -> httpx.Response:
+    sent = json.loads(request.content)
+    payment = testing.payment("succeeded", paymentReference=sent["paymentReference"])
+    return httpx.Response(201, json=payment)
+
+timbro = TimbroPayments(
+    api_key="sk_test_123",
+    http_client=httpx.Client(transport=httpx.MockTransport(handler)),
+)
+
+body = b'{"id":"event_...","type":"payment.succeeded"}'
+headers = testing.sign_webhook(body, "whsec_...", webhook_id="event_...")
+```
+
+## License
+
+No license has been granted for this package yet. The license will be declared before the first public release.

timbro_payments-0.10.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "timbro-payments"
+dynamic = ["version"]
+description = "Python SDK for Timbro Payments: payments, refunds, merchant accounts, webhook endpoints, and signed webhooks"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = ["timbro-protocol>=0.10,<0.11", "httpx>=0.27,<1"]
+authors = [{ name = "Timbro contributors" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://timbro.do"
+Source = "https://github.com/indexa-labs/checkout/tree/main/python/timbro-payments"
+
+[tool.setuptools.dynamic]
+version = { attr = "timbro_payments._version.__version__" }
+
+[tool.setuptools.package-data]
+timbro_payments = ["py.typed"]

timbro_payments-0.10.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

timbro_payments-0.10.0/src/timbro_payments/__init__.py

@@ -0,0 +1,60 @@
+"""Python SDK for Timbro Payments.
+
+```python
+from timbro_payments import TimbroPayments
+
+with TimbroPayments(api_key=key) as timbro:
+    payment = timbro.payments.create({
+        "paymentReference": "order-123-payment-1",
+        "amount": {"currency": "DOP", "value": "1250.00"},
+        "description": "Servicio",
+    })
+```
+"""
+
+from timbro_protocol import (
+    APIConnectionError,
+    APIError,
+    APITimeoutError,
+    AuthenticationError,
+    ConflictError,
+    InvalidRequestError,
+    NotFoundError,
+    PermissionDeniedError,
+    ProblemDetail,
+    RateLimitError,
+    ServerError,
+    TimbroError,
+    UnexpectedResponseError,
+    WebhookRejection,
+    WebhookVerificationError,
+)
+
+from . import types, webhooks
+from ._client import AsyncTimbroPayments, TimbroPayments
+from ._identity import payment_reference_for_source
+from ._version import __version__
+
+__all__ = [
+    "APIConnectionError",
+    "APIError",
+    "APITimeoutError",
+    "AsyncTimbroPayments",
+    "AuthenticationError",
+    "ConflictError",
+    "InvalidRequestError",
+    "NotFoundError",
+    "PermissionDeniedError",
+    "ProblemDetail",
+    "RateLimitError",
+    "ServerError",
+    "TimbroError",
+    "TimbroPayments",
+    "UnexpectedResponseError",
+    "WebhookRejection",
+    "WebhookVerificationError",
+    "__version__",
+    "payment_reference_for_source",
+    "types",
+    "webhooks",
+]