dime-python-sdk 1.0.0__tar.gz

dime_python_sdk-1.0.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.coverage
+htmlcov/
+*.egg

dime_python_sdk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dime Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dime_python_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: dime-python-sdk
+Version: 1.0.0
+Summary: Python client for the Dime Payments API
+Author: Dime Technology
+License: MIT License
+        
+        Copyright (c) 2026 Dime Technology
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: api,dime,payments,sdk
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Dime Payments Python SDK
+
+A typed Python client for the [Dime Payments](https://dimepayments.com) API.
+Works with Python 3.10+ on any platform.
+
+```python
+from dime_payments import Client
+
+dime = Client('your-api-token')
+
+txn = dime.transactions.charge_card('000010', {
+    'amount': '49.99',
+    'token': 'tok_abc123',
+})
+
+print(txn.transaction_status)  # "Success"
+```
+
+## Requirements
+
+- Python 3.10+
+- A Dime API token (a Laravel Sanctum personal access token). Tokens are minted inside the
+  Dime application, not via this SDK, and carry abilities (e.g. `transaction:charge-card-token`,
+  `customer:read`) that gate which calls succeed.
+
+## Installation
+
+```bash
+pip install dime-python-sdk
+```
+
+## Configuration
+
+The simplest setup needs only a token:
+
+```python
+dime = Client('your-api-token')
+```
+
+Point it at another environment, or use `Config` for full control:
+
+```python
+from dime_payments import Client, Config
+
+# Staging environment
+dime = Client('your-api-token', 'https://staging.dimepayments.com')
+
+# Full control
+dime = Client(Config(
+    token='your-api-token',
+    base_url='https://app.dimepayments.com',
+    timeout=30.0,       # seconds
+    max_retries=2,      # retries 429 / 5xx / network errors with backoff
+    retry_base_delay=0.5,
+))
+```
+
+The SDK sends `Authorization: Bearer <token>` and JSON headers on every request. Transient
+failures (HTTP 429 and 5xx, network errors) are retried with exponential backoff, honoring the
+`Retry-After` header when present.
+
+## Resources
+
+Every resource hangs off the client as a property. The merchant `sid` is always passed
+explicitly; remaining fields go in an `attributes` or `filters` dict. All amounts are
+returned as strings to avoid float rounding.
+
+| Property                        | Endpoints                                                             |
+| ------------------------------- | --------------------------------------------------------------------- |
+| `dime.transactions`             | charge_card, charge_ach, tokenize_card, refund, void, show, list     |
+| `dime.customers`                | list, show, create, update, delete                                    |
+| `dime.payment_methods`          | list, show, create, update, delete                                    |
+| `dime.merchants`                | list, show, create, update, get_form_link                             |
+| `dime.addresses`                | list, show, create, update, delete                                    |
+| `dime.deposits`                 | list, list_with_transactions, show                                    |
+| `dime.recurring_payments`       | list, show, create, edit, pause, cancel, activate, delete             |
+
+### Transactions
+
+```python
+# Charge a stored token
+txn = dime.transactions.charge_card('000010', {
+    'amount': '100.00',
+    'token': 'tok_abc123',
+    'email': 'customer@example.com',
+})
+
+# Charge raw card details (merchant must be PCI compliant)
+txn = dime.transactions.charge_card('000010', {
+    'amount': '100.00',
+    'cardholder_name': 'John Doe',
+    'card_number': '4111111111111111',
+    'expiration_date': '01/2027',
+    'cvv': '123',
+})
+
+# ACH
+txn = dime.transactions.charge_ach('000010', {
+    'routing_number': '123456789',
+    'account_number': '9876543210',
+    'account_type': 'Checking',
+    'account_name': 'John Doe',
+    'amount': '75.00',
+})
+
+# Tokenize without charging
+result = dime.transactions.tokenize_card('000010', {
+    'cardholder_name': 'John Doe',
+    'card_number': '4111111111111111',
+    'expiration_date': '01/2027',
+})
+print(result.token)
+
+# Refund / void
+dime.transactions.refund('000010', {'amount': '25.00', 'transaction_info_id': 123456})
+dime.transactions.void('000010', 'CC', 123456)
+
+# Read
+txn = dime.transactions.show('000010', {'transaction_info_id': 123456})
+```
+
+### Customers, payment methods, addresses
+
+```python
+customer = dime.customers.create('000010', {
+    'first_name': 'Jane',
+    'last_name': 'Doe',
+    'email': 'jane@example.com',
+})
+
+pm = dime.payment_methods.create('000010', {
+    'uuid': customer.uuid,
+    'type': 'cc',
+    'cc_name_on_card': 'Jane Doe',
+    'cc_number': '4111111111111111',
+    'cc_expiration_date': '01/2027',
+    'cc_brand': 'Visa',
+    'default': True,
+})
+
+address = dime.addresses.create('000010', customer.uuid, {
+    'recipient': 'Jane Doe',
+    'line_one': '123 Main St',
+    'city': 'Atlanta',
+    'state': 'GA',
+    'zip': '30301',
+})
+```
+
+### Recurring payments
+
+```python
+rp = dime.recurring_payments.create('000010', {
+    'name': 'Monthly donation',
+    'amount': '25.00',
+    'start_date': '2026-07-01 00:00:00',
+    'recurrence_schedule': 'Monthly',
+    'payment_method': pm.id,
+    'customer_uuid': customer.uuid,
+})
+
+dime.recurring_payments.pause('000010', rp.id, '2026-09-01 00:00:00')
+dime.recurring_payments.activate('000010', rp.id)
+dime.recurring_payments.cancel('000010', rp.id)
+```
+
+## Pagination
+
+List endpoints return a `CursorPage`. Iterate one page, walk pages manually, or stream every
+item across all pages with `auto_paging()`:
+
+```python
+page = dime.transactions.list('000010', {
+    'start_date': '2026-01-01 00:00:00',
+    'end_date': '2026-01-31 23:59:59',
+})
+
+# First page only
+for txn in page:
+    print(txn.amount)
+
+# Next page manually
+if page.has_more():
+    next_page = page.next()
+
+# Every transaction across every page (fetches lazily)
+for txn in page.auto_paging():
+    print(txn.transaction_number)
+```
+
+## Error handling
+
+Every failure raises a `DimeException` subclass. Catch the base type, or a specific one:
+
+```python
+from dime_payments import (
+    DimeException,
+    ValidationException,
+    RateLimitException,
+)
+import time
+
+try:
+    dime.transactions.charge_card('000010', {'amount': '0'})
+except ValidationException as e:
+    e.get_errors()   # {'data.amount': ['must be greater than 0']}
+    e.first_error()
+except RateLimitException as e:
+    wait = e.get_retry_after() or 1
+    time.sleep(wait)
+except DimeException as e:
+    e.get_status_code()    # HTTP status
+    e.get_response_body()  # decoded API body
+```
+
+| Exception                    | When                                                         |
+| ---------------------------- | ------------------------------------------------------------ |
+| `ValidationException`        | HTTP 400/422 with field errors                               |
+| `AuthenticationException`    | HTTP 401 (missing/invalid token)                             |
+| `PermissionDeniedException`  | HTTP 403 (belongs-to-company guard)                          |
+| `NotFoundException`          | HTTP 404                                                     |
+| `RateLimitException`         | HTTP 429 (carries `Retry-After`)                             |
+| `ServerException`            | HTTP 5xx                                                     |
+| `ConnectionException`        | No HTTP response (DNS, timeout, network error)               |
+| `ApiException`               | Any other non-2xx                                            |
+
+## Notes
+
+- **GET requests carry a JSON body.** The Dime API expects read parameters in the request body
+  even for `GET` endpoints; the SDK handles this transparently.
+- **No API versioning.** Endpoints live under `/api` with no version prefix.
+
+## Development
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest                  # run tests
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

dime_python_sdk-1.0.0/README.md

@@ -0,0 +1,244 @@
+# Dime Payments Python SDK
+
+A typed Python client for the [Dime Payments](https://dimepayments.com) API.
+Works with Python 3.10+ on any platform.
+
+```python
+from dime_payments import Client
+
+dime = Client('your-api-token')
+
+txn = dime.transactions.charge_card('000010', {
+    'amount': '49.99',
+    'token': 'tok_abc123',
+})
+
+print(txn.transaction_status)  # "Success"
+```
+
+## Requirements
+
+- Python 3.10+
+- A Dime API token (a Laravel Sanctum personal access token). Tokens are minted inside the
+  Dime application, not via this SDK, and carry abilities (e.g. `transaction:charge-card-token`,
+  `customer:read`) that gate which calls succeed.
+
+## Installation
+
+```bash
+pip install dime-python-sdk
+```
+
+## Configuration
+
+The simplest setup needs only a token:
+
+```python
+dime = Client('your-api-token')
+```
+
+Point it at another environment, or use `Config` for full control:
+
+```python
+from dime_payments import Client, Config
+
+# Staging environment
+dime = Client('your-api-token', 'https://staging.dimepayments.com')
+
+# Full control
+dime = Client(Config(
+    token='your-api-token',
+    base_url='https://app.dimepayments.com',
+    timeout=30.0,       # seconds
+    max_retries=2,      # retries 429 / 5xx / network errors with backoff
+    retry_base_delay=0.5,
+))
+```
+
+The SDK sends `Authorization: Bearer <token>` and JSON headers on every request. Transient
+failures (HTTP 429 and 5xx, network errors) are retried with exponential backoff, honoring the
+`Retry-After` header when present.
+
+## Resources
+
+Every resource hangs off the client as a property. The merchant `sid` is always passed
+explicitly; remaining fields go in an `attributes` or `filters` dict. All amounts are
+returned as strings to avoid float rounding.
+
+| Property                        | Endpoints                                                             |
+| ------------------------------- | --------------------------------------------------------------------- |
+| `dime.transactions`             | charge_card, charge_ach, tokenize_card, refund, void, show, list     |
+| `dime.customers`                | list, show, create, update, delete                                    |
+| `dime.payment_methods`          | list, show, create, update, delete                                    |
+| `dime.merchants`                | list, show, create, update, get_form_link                             |
+| `dime.addresses`                | list, show, create, update, delete                                    |
+| `dime.deposits`                 | list, list_with_transactions, show                                    |
+| `dime.recurring_payments`       | list, show, create, edit, pause, cancel, activate, delete             |
+
+### Transactions
+
+```python
+# Charge a stored token
+txn = dime.transactions.charge_card('000010', {
+    'amount': '100.00',
+    'token': 'tok_abc123',
+    'email': 'customer@example.com',
+})
+
+# Charge raw card details (merchant must be PCI compliant)
+txn = dime.transactions.charge_card('000010', {
+    'amount': '100.00',
+    'cardholder_name': 'John Doe',
+    'card_number': '4111111111111111',
+    'expiration_date': '01/2027',
+    'cvv': '123',
+})
+
+# ACH
+txn = dime.transactions.charge_ach('000010', {
+    'routing_number': '123456789',
+    'account_number': '9876543210',
+    'account_type': 'Checking',
+    'account_name': 'John Doe',
+    'amount': '75.00',
+})
+
+# Tokenize without charging
+result = dime.transactions.tokenize_card('000010', {
+    'cardholder_name': 'John Doe',
+    'card_number': '4111111111111111',
+    'expiration_date': '01/2027',
+})
+print(result.token)
+
+# Refund / void
+dime.transactions.refund('000010', {'amount': '25.00', 'transaction_info_id': 123456})
+dime.transactions.void('000010', 'CC', 123456)
+
+# Read
+txn = dime.transactions.show('000010', {'transaction_info_id': 123456})
+```
+
+### Customers, payment methods, addresses
+
+```python
+customer = dime.customers.create('000010', {
+    'first_name': 'Jane',
+    'last_name': 'Doe',
+    'email': 'jane@example.com',
+})
+
+pm = dime.payment_methods.create('000010', {
+    'uuid': customer.uuid,
+    'type': 'cc',
+    'cc_name_on_card': 'Jane Doe',
+    'cc_number': '4111111111111111',
+    'cc_expiration_date': '01/2027',
+    'cc_brand': 'Visa',
+    'default': True,
+})
+
+address = dime.addresses.create('000010', customer.uuid, {
+    'recipient': 'Jane Doe',
+    'line_one': '123 Main St',
+    'city': 'Atlanta',
+    'state': 'GA',
+    'zip': '30301',
+})
+```
+
+### Recurring payments
+
+```python
+rp = dime.recurring_payments.create('000010', {
+    'name': 'Monthly donation',
+    'amount': '25.00',
+    'start_date': '2026-07-01 00:00:00',
+    'recurrence_schedule': 'Monthly',
+    'payment_method': pm.id,
+    'customer_uuid': customer.uuid,
+})
+
+dime.recurring_payments.pause('000010', rp.id, '2026-09-01 00:00:00')
+dime.recurring_payments.activate('000010', rp.id)
+dime.recurring_payments.cancel('000010', rp.id)
+```
+
+## Pagination
+
+List endpoints return a `CursorPage`. Iterate one page, walk pages manually, or stream every
+item across all pages with `auto_paging()`:
+
+```python
+page = dime.transactions.list('000010', {
+    'start_date': '2026-01-01 00:00:00',
+    'end_date': '2026-01-31 23:59:59',
+})
+
+# First page only
+for txn in page:
+    print(txn.amount)
+
+# Next page manually
+if page.has_more():
+    next_page = page.next()
+
+# Every transaction across every page (fetches lazily)
+for txn in page.auto_paging():
+    print(txn.transaction_number)
+```
+
+## Error handling
+
+Every failure raises a `DimeException` subclass. Catch the base type, or a specific one:
+
+```python
+from dime_payments import (
+    DimeException,
+    ValidationException,
+    RateLimitException,
+)
+import time
+
+try:
+    dime.transactions.charge_card('000010', {'amount': '0'})
+except ValidationException as e:
+    e.get_errors()   # {'data.amount': ['must be greater than 0']}
+    e.first_error()
+except RateLimitException as e:
+    wait = e.get_retry_after() or 1
+    time.sleep(wait)
+except DimeException as e:
+    e.get_status_code()    # HTTP status
+    e.get_response_body()  # decoded API body
+```
+
+| Exception                    | When                                                         |
+| ---------------------------- | ------------------------------------------------------------ |
+| `ValidationException`        | HTTP 400/422 with field errors                               |
+| `AuthenticationException`    | HTTP 401 (missing/invalid token)                             |
+| `PermissionDeniedException`  | HTTP 403 (belongs-to-company guard)                          |
+| `NotFoundException`          | HTTP 404                                                     |
+| `RateLimitException`         | HTTP 429 (carries `Retry-After`)                             |
+| `ServerException`            | HTTP 5xx                                                     |
+| `ConnectionException`        | No HTTP response (DNS, timeout, network error)               |
+| `ApiException`               | Any other non-2xx                                            |
+
+## Notes
+
+- **GET requests carry a JSON body.** The Dime API expects read parameters in the request body
+  even for `GET` endpoints; the SDK handles this transparently.
+- **No API versioning.** Endpoints live under `/api` with no version prefix.
+
+## Development
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest                  # run tests
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

dime_python_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dime-python-sdk"
+version = "1.0.0"
+description = "Python client for the Dime Payments API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Dime Technology"},
+]
+keywords = ["dime", "payments", "sdk", "api"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "requests>=2.28",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dime_payments"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

dime_python_sdk-1.0.0/src/dime_payments/__init__.py

@@ -0,0 +1,29 @@
+from .client import Client
+from .config import Config
+from .exceptions import (
+    ApiException,
+    AuthenticationException,
+    ConnectionException,
+    DimeException,
+    NotFoundException,
+    PermissionDeniedException,
+    RateLimitException,
+    ServerException,
+    ValidationException,
+)
+from .pagination.cursor_page import CursorPage
+
+__all__ = [
+    'Client',
+    'Config',
+    'CursorPage',
+    'DimeException',
+    'ValidationException',
+    'AuthenticationException',
+    'PermissionDeniedException',
+    'NotFoundException',
+    'RateLimitException',
+    'ServerException',
+    'ApiException',
+    'ConnectionException',
+]

dime_python_sdk-1.0.0/src/dime_payments/client.py

@@ -0,0 +1,30 @@
+from .config import Config
+from .http.transport import Transport
+from .resources.addresses import Addresses
+from .resources.customers import Customers
+from .resources.deposits import Deposits
+from .resources.merchants import Merchants
+from .resources.payment_methods import PaymentMethods
+from .resources.recurring_payments import RecurringPayments
+from .resources.transactions import Transactions
+
+
+class Client:
+    def __init__(self, token: str | Config, base_url: str = Config.DEFAULT_BASE_URL) -> None:
+        if isinstance(token, Config):
+            self._config = token
+        else:
+            self._config = Config(token=token, base_url=base_url)
+
+        transport = Transport(self._config)
+
+        self.transactions = Transactions(transport)
+        self.customers = Customers(transport)
+        self.payment_methods = PaymentMethods(transport)
+        self.merchants = Merchants(transport)
+        self.addresses = Addresses(transport)
+        self.deposits = Deposits(transport)
+        self.recurring_payments = RecurringPayments(transport)
+
+    def config(self) -> Config:
+        return self._config

dime_python_sdk-1.0.0/src/dime_payments/config.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Callable
+
+if TYPE_CHECKING:
+    import requests
+
+
+class Config:
+    DEFAULT_BASE_URL = 'https://app.dimepayments.com'
+    VERSION = '1.0.0'
+
+    def __init__(
+        self,
+        token: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = 30.0,
+        max_retries: int = 2,
+        retry_base_delay: float = 0.5,
+        session: 'requests.Session | None' = None,
+        sleep: Callable[[float], None] | None = None,
+    ) -> None:
+        self.token = token
+        self.base_url = base_url
+        self.timeout = timeout
+        self.max_retries = max_retries
+        self.retry_base_delay = retry_base_delay
+        self._session = session
+        self._sleep = sleep
+
+    def base_uri(self) -> str:
+        return self.base_url.rstrip('/') + '/api/'