karni-payments 0.3.1__tar.gz

karni_payments-0.3.1/.gitignore

@@ -0,0 +1,38 @@
+.learning/
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Build artifacts
+dist/
+build/
+packages/karni-cli/karni_cli/_templates/
+packages/karni-cli/karni_cli/_agent/
+packages/karni-cli/karni_cli/_changelog/
+packages/karni-cli/karni_cli/_errorcodes/
+
+# Node
+node_modules/
+storybook-static/
+*.tsbuildinfo
+
+# Local env / editor / tooling
+.env
+.env.*
+!.env.example
+.DS_Store
+.idea/
+.claude/scheduled_tasks.lock
+.claude/settings.local.json
+
+# MkDocs build output
+site/

karni_payments-0.3.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

karni_payments-0.3.1/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.5
+Name: karni-payments
+Version: 0.3.1
+Summary: Payments module for the Karni Django + React framework: hosted checkout, refunds and signature-verified webhooks for Stripe and Razorpay, with a test provider for CI.
+Project-URL: Homepage, https://github.com/cbsshekhawat18-lab/karni
+Project-URL: Documentation, https://cbsshekhawat18-lab.github.io/karni/
+Project-URL: Repository, https://github.com/cbsshekhawat18-lab/karni
+Project-URL: Issues, https://github.com/cbsshekhawat18-lab/karni/issues
+Project-URL: Changelog, https://github.com/cbsshekhawat18-lab/karni/tree/main/docs/migrations
+Author-email: Chandrabhan Shekhawat <cbsshekhawat18@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: checkout,django,karni,payments,razorpay,react,stripe,webhooks
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: karni<0.4,>=0.3
+Provides-Extra: razorpay
+Requires-Dist: razorpay>=1.4; extra == 'razorpay'
+Provides-Extra: stripe
+Requires-Dist: stripe>=10; extra == 'stripe'
+Description-Content-Type: text/markdown
+
+# karni-payments
+
+Payments module for [Karni](https://github.com/cbsshekhawat18-lab/karni): hosted checkout, refunds and
+webhook-driven payment state for **Stripe** (Checkout Sessions) and
+**Razorpay** (Payment Links), plus an in-memory **test provider**.
+
+```bash
+karni add payments        # wires dependency + INSTALLED_APPS + agent guidance
+pip install "karni-payments[stripe]"    # or [razorpay]
+```
+
+One line of project wiring (the viewsets ride Karni's auto-router):
+
+```python
+# config/urls.py
+(path("payments/", include("karni_payments.urls")),)  # the webhook endpoint
+```
+
+then `make migrate`. Register `https://<host>/payments/webhook/stripe/` (or
+`.../razorpay/`) at the provider.
+
+## What you get
+
+- **Models** (all on `karni.models.BaseModel`): `Payment`, `Refund`,
+  `WebhookEvent` (the `(provider, event_id)` dedupe record). Derived admin
+  via `AdminMeta` — no `admin.py`.
+- **API** (auto-routed, authenticated only):
+  - `GET /api/payments/` — owner-scoped; the `payments-admin` role sees all.
+  - `POST /api/payments/checkout/` — create a pending payment + provider
+    session; redirect the customer to the returned `url`.
+  - `POST /api/payments/{id}/refund/` — requires the `payments-admin` role;
+    omit `amount` to refund the full unrefunded remainder.
+  - `GET /api/refunds/` — `payments-admin` only.
+  - Writes to the resources themselves answer 405: state belongs to webhooks.
+- **Webhooks**: `POST /payments/webhook/<provider>/` verifies the signature
+  (400 + warning log on failure, nothing persisted), dedupes on
+  `(provider, event_id)` and hands processing to a Celery task
+  (`process_webhook_event`: row lock + monotonic state machine +
+  `processed_at` stamp in one transaction; 3 retries with backoff). Nothing
+  state-changing runs in the request cycle.
+- **Services** (`karni_payments.services`) — the only module project code
+  should call: `create_checkout`, `create_refund` (lock-validated against
+  the unrefunded remainder — over-refunds are impossible), `apply_event`.
+
+## Settings (via the `karni.settings` fragment — all overridable)
+
+| Setting (env var of the same name)  | Default | Meaning |
+| --- | --- | --- |
+| `KARNI_PAYMENTS_PROVIDER` | `"stripe"` | `"stripe"`, `"razorpay"`, `"test"` or a dotted path to your own `PaymentProvider` subclass |
+| `KARNI_PAYMENTS_CURRENCY` | `"usd"` | default checkout currency |
+| `KARNI_PAYMENTS_CHECKOUT_VALIDATOR` | pass-through | dotted path called with `(user=, amount=, currency=, metadata=)` **before** a Payment exists — set it; never trust client amounts |
+| `KARNI_PAYMENTS_EVENT_HANDLER` | `karni_payments.services.apply_event` | dotted path the webhook task calls — the state-machine escape hatch |
+| `KARNI_PAYMENTS_ALLOWED_REDIRECTS` | `[]` | extra origins allowed for checkout redirect URLs (on top of `KARNI_FRONTEND_URL`) |
+| `STRIPE_SECRET_KEY` / `STRIPE_WEBHOOK_SECRET` | `""` | validated lazily at provider use |
+| `RAZORPAY_KEY_ID` / `RAZORPAY_KEY_SECRET` / `RAZORPAY_WEBHOOK_SECRET` | `""` | validated lazily at provider use |
+
+## Semantics worth knowing
+
+- **Monotonic state**: `pending → processing → succeeded →
+  partially_refunded → refunded`; `failed`/`canceled` are terminal. Events
+  that would regress a status are recorded as a `no-op:` note on the
+  `WebhookEvent` and count as processed. Expired checkout sessions map to
+  `canceled`.
+- **Zero-decimal currencies** (JPY, KRW, …) are handled by
+  `providers.base.to_minor_units` / `from_minor_units`; 3-decimal currencies
+  (BHD, KWD, …) are unsupported in v0.1 and raise.
+- A provider failure during checkout marks the Payment `failed` before
+  re-raising. Abandoned pending payments are not reaped in v0.1 — expire
+  them yourself if you need to (sessions that expire at the provider arrive
+  as webhook events and cancel the payment).
+- Razorpay webhooks take their event id from the `X-Razorpay-Event-Id`
+  header; Payment Links have a single `callback_url`, so `cancel_url` is
+  unused there.
+
+## Testing your project
+
+Set `KARNI_PAYMENTS_PROVIDER = "test"` in test settings:
+`TestProvider` is in-memory and deterministic (`test_cs_1`, `test_re_1`, …),
+and `TestProvider.build_webhook({...})` returns a correctly signed
+`(body, headers)` pair for driving the full webhook pipeline. Call
+`TestProvider.reset()` between tests.
+
+## Development
+
+```bash
+pip install -e . --group dev
+python -m pytest        # standalone suite (sqlite + eager Celery + TestProvider)
+ruff check . && ruff format --check .
+```
+
+This module is also the reference implementation of the Karni module
+contract — see `docs/modules.md` in the Karni repo.

karni_payments-0.3.1/README.md

@@ -0,0 +1,92 @@
+# karni-payments
+
+Payments module for [Karni](https://github.com/cbsshekhawat18-lab/karni): hosted checkout, refunds and
+webhook-driven payment state for **Stripe** (Checkout Sessions) and
+**Razorpay** (Payment Links), plus an in-memory **test provider**.
+
+```bash
+karni add payments        # wires dependency + INSTALLED_APPS + agent guidance
+pip install "karni-payments[stripe]"    # or [razorpay]
+```
+
+One line of project wiring (the viewsets ride Karni's auto-router):
+
+```python
+# config/urls.py
+(path("payments/", include("karni_payments.urls")),)  # the webhook endpoint
+```
+
+then `make migrate`. Register `https://<host>/payments/webhook/stripe/` (or
+`.../razorpay/`) at the provider.
+
+## What you get
+
+- **Models** (all on `karni.models.BaseModel`): `Payment`, `Refund`,
+  `WebhookEvent` (the `(provider, event_id)` dedupe record). Derived admin
+  via `AdminMeta` — no `admin.py`.
+- **API** (auto-routed, authenticated only):
+  - `GET /api/payments/` — owner-scoped; the `payments-admin` role sees all.
+  - `POST /api/payments/checkout/` — create a pending payment + provider
+    session; redirect the customer to the returned `url`.
+  - `POST /api/payments/{id}/refund/` — requires the `payments-admin` role;
+    omit `amount` to refund the full unrefunded remainder.
+  - `GET /api/refunds/` — `payments-admin` only.
+  - Writes to the resources themselves answer 405: state belongs to webhooks.
+- **Webhooks**: `POST /payments/webhook/<provider>/` verifies the signature
+  (400 + warning log on failure, nothing persisted), dedupes on
+  `(provider, event_id)` and hands processing to a Celery task
+  (`process_webhook_event`: row lock + monotonic state machine +
+  `processed_at` stamp in one transaction; 3 retries with backoff). Nothing
+  state-changing runs in the request cycle.
+- **Services** (`karni_payments.services`) — the only module project code
+  should call: `create_checkout`, `create_refund` (lock-validated against
+  the unrefunded remainder — over-refunds are impossible), `apply_event`.
+
+## Settings (via the `karni.settings` fragment — all overridable)
+
+| Setting (env var of the same name)  | Default | Meaning |
+| --- | --- | --- |
+| `KARNI_PAYMENTS_PROVIDER` | `"stripe"` | `"stripe"`, `"razorpay"`, `"test"` or a dotted path to your own `PaymentProvider` subclass |
+| `KARNI_PAYMENTS_CURRENCY` | `"usd"` | default checkout currency |
+| `KARNI_PAYMENTS_CHECKOUT_VALIDATOR` | pass-through | dotted path called with `(user=, amount=, currency=, metadata=)` **before** a Payment exists — set it; never trust client amounts |
+| `KARNI_PAYMENTS_EVENT_HANDLER` | `karni_payments.services.apply_event` | dotted path the webhook task calls — the state-machine escape hatch |
+| `KARNI_PAYMENTS_ALLOWED_REDIRECTS` | `[]` | extra origins allowed for checkout redirect URLs (on top of `KARNI_FRONTEND_URL`) |
+| `STRIPE_SECRET_KEY` / `STRIPE_WEBHOOK_SECRET` | `""` | validated lazily at provider use |
+| `RAZORPAY_KEY_ID` / `RAZORPAY_KEY_SECRET` / `RAZORPAY_WEBHOOK_SECRET` | `""` | validated lazily at provider use |
+
+## Semantics worth knowing
+
+- **Monotonic state**: `pending → processing → succeeded →
+  partially_refunded → refunded`; `failed`/`canceled` are terminal. Events
+  that would regress a status are recorded as a `no-op:` note on the
+  `WebhookEvent` and count as processed. Expired checkout sessions map to
+  `canceled`.
+- **Zero-decimal currencies** (JPY, KRW, …) are handled by
+  `providers.base.to_minor_units` / `from_minor_units`; 3-decimal currencies
+  (BHD, KWD, …) are unsupported in v0.1 and raise.
+- A provider failure during checkout marks the Payment `failed` before
+  re-raising. Abandoned pending payments are not reaped in v0.1 — expire
+  them yourself if you need to (sessions that expire at the provider arrive
+  as webhook events and cancel the payment).
+- Razorpay webhooks take their event id from the `X-Razorpay-Event-Id`
+  header; Payment Links have a single `callback_url`, so `cancel_url` is
+  unused there.
+
+## Testing your project
+
+Set `KARNI_PAYMENTS_PROVIDER = "test"` in test settings:
+`TestProvider` is in-memory and deterministic (`test_cs_1`, `test_re_1`, …),
+and `TestProvider.build_webhook({...})` returns a correctly signed
+`(body, headers)` pair for driving the full webhook pipeline. Call
+`TestProvider.reset()` between tests.
+
+## Development
+
+```bash
+pip install -e . --group dev
+python -m pytest        # standalone suite (sqlite + eager Celery + TestProvider)
+ruff check . && ruff format --check .
+```
+
+This module is also the reference implementation of the Karni module
+contract — see `docs/modules.md` in the Karni repo.

karni_payments-0.3.1/karni_payments/AGENTS.fragment.md

@@ -0,0 +1,14 @@
+## Payments (karni-payments)
+- Checkout, refunds and webhook-driven state ship ready-made. Never call
+  provider SDKs (stripe/razorpay) directly — go through `karni_payments.services`.
+- NEVER trust client amounts: set `KARNI_PAYMENTS_CHECKOUT_VALIDATOR` (dotted
+  path) to enforce server-side pricing, or override the checkout action.
+- Wire URLs once in config/urls.py:
+  `path("payments/", include("karni_payments.urls"))`
+- API rides the auto-router: `/api/payments/` + `checkout/` (POST) +
+  `{id}/refund/` (POST, role `payments-admin`), `/api/refunds/` (same role).
+- Settings arrive via the module's settings fragment; env vars:
+  KARNI_PAYMENTS_PROVIDER (stripe|razorpay|test|dotted path),
+  KARNI_PAYMENTS_CURRENCY, STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET,
+  RAZORPAY_KEY_ID, RAZORPAY_KEY_SECRET, RAZORPAY_WEBHOOK_SECRET.
+- Webhook state changes run in Celery — keep the worker service running.

karni_payments-0.3.1/karni_payments/__init__.py

@@ -0,0 +1,14 @@
+"""karni-payments — the Karni payments module (Stripe, Razorpay, test provider).
+
+Checkout sessions, refunds and webhook-driven payment state, built on Karni's
+bases: models on :class:`karni.models.BaseModel`, viewsets on
+:class:`karni.api.BaseViewSet`, settings via the ``karni.settings`` fragment,
+admin derived via ``AdminMeta``.
+
+Project code talks to :mod:`karni_payments.services` — never to a provider
+SDK directly.
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"

karni_payments-0.3.1/karni_payments/api.py

@@ -0,0 +1,77 @@
+"""Hand-written serializers for the payments API actions.
+
+Only the ``checkout`` / ``refund`` action payloads live here — the resource
+serializers for ``Payment`` and ``Refund`` are generated by
+:func:`karni.api.serializers.build_serializer` from the models' ``APIMeta``
+(see :mod:`karni_payments.viewsets`). These explicit input/output
+serializers feed ``@extend_schema`` so the OpenAPI schema (and with it
+@karni/ui's typed client) knows the action shapes.
+
+Override / escape hatch: subclass the viewset and swap the serializer in an
+overridden action; these classes are plain DRF serializers.
+"""
+
+from __future__ import annotations
+
+from decimal import Decimal
+
+from rest_framework import serializers
+
+from karni_payments.models import Refund
+
+__all__ = [
+    "CheckoutInputSerializer",
+    "CheckoutOutputSerializer",
+    "RefundInputSerializer",
+    "RefundSerializer",
+]
+
+
+class CheckoutInputSerializer(serializers.Serializer):
+    """Input of ``POST /api/payments/checkout/``.
+
+    The amount is transport, not authority: the server-side
+    ``KARNI_PAYMENTS_CHECKOUT_VALIDATOR`` decides whether it is acceptable
+    (amendment G2 — never trust client amounts).
+    """
+
+    amount = serializers.DecimalField(max_digits=12, decimal_places=2, min_value=Decimal("0.01"))
+    currency = serializers.CharField(max_length=3, required=False)
+    metadata = serializers.JSONField(required=False)
+    success_url = serializers.URLField(max_length=2000)
+    cancel_url = serializers.URLField(max_length=2000)
+
+
+class CheckoutOutputSerializer(serializers.Serializer):
+    """Output of the checkout action: redirect the customer to ``url``."""
+
+    payment_id = serializers.UUIDField(read_only=True)
+    session_id = serializers.CharField(read_only=True)
+    url = serializers.URLField(read_only=True)
+
+
+class RefundInputSerializer(serializers.Serializer):
+    """Input of ``POST /api/payments/{id}/refund/`` (empty body → full remainder)."""
+
+    amount = serializers.DecimalField(
+        max_digits=12, decimal_places=2, min_value=Decimal("0.01"), required=False
+    )
+    reason = serializers.CharField(max_length=255, required=False, allow_blank=True, default="")
+
+
+class RefundSerializer(serializers.ModelSerializer):
+    """Read-only representation of a refund (the refund action's response)."""
+
+    class Meta:
+        model = Refund
+        fields = [
+            "id",
+            "payment",
+            "amount",
+            "status",
+            "provider_refund_id",
+            "reason",
+            "created_at",
+            "updated_at",
+        ]
+        read_only_fields = fields

karni_payments-0.3.1/karni_payments/apps.py

@@ -0,0 +1,20 @@
+"""Django app configuration for ``karni_payments``."""
+
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+
+class KarniPaymentsConfig(AppConfig):
+    """App config for the Karni payments module (label ``karni_payments``).
+
+    Override / escape hatch: subclass this config in your project and point
+    ``INSTALLED_APPS`` at the subclass's dotted path to change startup
+    behaviour; the app label must stay ``karni_payments`` so the shipped
+    migrations keep applying.
+    """
+
+    name = "karni_payments"
+    label = "karni_payments"
+    verbose_name = "Karni payments"
+    default_auto_field = "django.db.models.BigAutoField"

karni_payments-0.3.1/karni_payments/conf.py

@@ -0,0 +1,71 @@
+"""Settings vocabulary for karni-payments.
+
+:data:`DEFAULTS` is the module's **settings fragment**: it is exposed through
+the ``karni.settings`` entry point (see this module's ``pyproject.toml``), so
+:func:`karni.conf.karni_settings` merges it into every project's settings
+automatically — after Karni's BASE/profile defaults and before project
+overrides, new top-level names only.
+
+The fragment is import-light on purpose: plain data plus django-environ
+reads, and it never touches ``django.conf.settings`` at import time.
+Per-profile values would read ``os.environ["DJANGO_ENV"]`` here directly —
+the documented hatch, since fragments merge before profiles are observable.
+
+:func:`get` is the accessor every ``karni_payments`` module reads settings
+through — ``getattr(settings, name, DEFAULTS[name])`` — so the module also
+works in projects that configure Django without ``karni_settings()`` (the
+fragment merge is convenience, not correctness).
+
+Override / escape hatch: define any of these names in your ``settings.py``
+(before or after ``karni_settings()``) or set the matching environment
+variable; provider credentials default to ``""`` and are validated lazily at
+provider use, never at boot.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import environ
+from django.conf import settings
+
+env = environ.Env()
+
+DEFAULTS: dict[str, Any] = {
+    # Active provider: "stripe", "razorpay", "test" or any dotted path to a
+    # karni_payments.providers.base.PaymentProvider subclass (the escape
+    # hatch for custom gateways).
+    "KARNI_PAYMENTS_PROVIDER": env("KARNI_PAYMENTS_PROVIDER", default="stripe"),
+    # Default ISO currency code used when create_checkout gets none.
+    "KARNI_PAYMENTS_CURRENCY": env("KARNI_PAYMENTS_CURRENCY", default="usd"),
+    # Dotted path called with (user=, amount=, currency=, metadata=) BEFORE a
+    # Payment is created — the server-side pricing authority. The default is
+    # a pass-through; production projects should replace it (never trust
+    # client amounts).
+    "KARNI_PAYMENTS_CHECKOUT_VALIDATOR": ("karni_payments.services.default_checkout_validator"),
+    # Dotted path of the webhook state machine applied by the Celery task.
+    "KARNI_PAYMENTS_EVENT_HANDLER": "karni_payments.services.apply_event",
+    # Extra URLs whose origins are allowed as checkout success/cancel
+    # redirects, on top of KARNI_FRONTEND_URL's origin.
+    "KARNI_PAYMENTS_ALLOWED_REDIRECTS": env.list("KARNI_PAYMENTS_ALLOWED_REDIRECTS", default=[]),
+    # Provider credentials — blank by default, validated lazily at use.
+    "STRIPE_SECRET_KEY": env("STRIPE_SECRET_KEY", default=""),
+    "STRIPE_WEBHOOK_SECRET": env("STRIPE_WEBHOOK_SECRET", default=""),
+    "RAZORPAY_KEY_ID": env("RAZORPAY_KEY_ID", default=""),
+    "RAZORPAY_KEY_SECRET": env("RAZORPAY_KEY_SECRET", default=""),
+    "RAZORPAY_WEBHOOK_SECRET": env("RAZORPAY_WEBHOOK_SECRET", default=""),
+}
+"""The karni-payments settings fragment (``karni.settings`` entry point)."""
+
+
+def get(name: str) -> Any:
+    """Return the effective value of a karni-payments setting.
+
+    Project settings win; :data:`DEFAULTS` is the fallback, so the accessor
+    works whether or not the project assembled its settings through
+    ``karni_settings()``.
+
+    :raises KeyError: when ``name`` is not a karni-payments setting and the
+        project has not defined it either.
+    """
+    return getattr(settings, name, DEFAULTS[name])