payme-pkg 3.3.0__cp312-cp312-macosx_10_13_universal2.whl

payme_pkg-3.3.0.dist-info/METADATA

@@ -0,0 +1,444 @@
+Metadata-Version: 2.4
+Name: payme_pkg
+Version: 3.3.0
+Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
+Author: Muhammadali Akbarov
+Author-email: muhammadali17abc@gmail.com
+License: MIT
+Keywords: paymeuz paycomuz payme-merchant merchant-api subscribe-api payme-pkg payme-api
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: requests==2.*
+Requires-Dist: dataclasses==0.*; python_version < "3.7"
+Requires-Dist: djangorestframework==3.*
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+
+<h1 align="center">Payme Software Development Kit</h1>
+
+<p align="center">
+  <a href="https://t.me/+lO97J78xBj45MzBi">
+    <img src="https://img.shields.io/badge/Support%20Group-blue?logo=telegram&logoColor=white" alt="Support Group on Telegram"/>
+  </a>
+</p>
+
+<p align="center">
+  <a href="#table-of-contents"><img src="https://img.shields.io/static/v1?message=Documentation&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="https://t.me/+lO97J78xBj45MzBi"><img src="https://img.shields.io/badge/Support%2024/7-💬-FDA599?"/></a>
+  <a href="https://github.com/PayTechUz/payme-pkg/issues">
+    <img src="https://img.shields.io/github/issues/PayTechUz/payme-pkg" />
+  </a>
+  <a href="https://pepy.tech/project/payme-pkg">
+    <img src="https://static.pepy.tech/badge/payme-pkg" alt="PyPI - Downloads" />
+  </a>
+</p>
+
+<p align="center">Welcome to payme-pkg, the Payme SDK for Python.</p>
+
+<p align="center">You can use it for test and production mode. Join our community and ask everything you need.</p>
+
+<p align="center">
+  <a href="https://youtu.be/7q7-c72tHpc?si=Sr0EAmEawWAFRk1m" target="_blank">
+    <img src="https://img.shields.io/badge/Watch%20Demo-red?logo=youtube&logoColor=white&style=for-the-badge" 
+         alt="Watch the YouTube Demo" 
+         style="width: 150px; height: 30px; border-radius: 7px;" />
+  </a>
+</p>
+
+
+## Installation
+
+```shell
+pip install payme-pkg
+```
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Django Integration](#django-integration)
+- [Payme Client SDK](#payme-client-sdk)
+  - [Initialization](#initialization)
+  - [Cards API](#cards-api)
+    - [Create Card](#create-card)
+    - [Get Verify Code](#get-verify-code)
+    - [Verify Card](#verify-card)
+    - [Check Card](#check-card)
+    - [Remove Card](#remove-card)
+    - [Test Cards](#test-cards)
+  - [Receipts API](#receipts-api)
+    - [Create Receipt](#create-receipt)
+    - [Pay Receipt](#pay-receipt)
+    - [Send Receipt](#send-receipt)
+    - [Cancel Receipt](#cancel-receipt)
+    - [Check Receipt](#check-receipt)
+    - [Get Receipt](#get-receipt)
+    - [Get All Receipts](#get-all-receipts)
+    - [Set Fiscal Data](#set-fiscal-data)
+    - [Test Receipts](#test-receipts)
+  - [Payment Initialization](#payment-initialization)
+    - [Generate Pay Link](#generate-pay-link)
+    - [Generate Fallback Link](#generate-fallback-link)
+
+## Django Integration
+
+Add `'payme'` in to your settings.py
+
+```python
+INSTALLED_APPS = [
+    ...
+    'payme',
+    ...
+]
+```
+
+Add `'payme'` credentials inside to settings.py (if you have api key)
+
+One time payment (Однаразовый платеж) configuration settings.py
+
+Example project: https://github.com/PayTechUz/shop-backend
+```python
+
+PAYTECH_API_KEY = "your-api-key" # contact with @muhammadali_me on Telegram for getting api key 
+
+PAYME_ID = "your-payme-id"
+PAYME_KEY = "your-payme-key"
+PAYME_ACCOUNT_FIELD = "order_id"
+PAYME_AMOUNT_FIELD = "total_amount"
+PAYME_ACCOUNT_MODEL = "orders.models.Orders"
+PAYME_ONE_TIME_PAYMENT = True
+
+PAYME_DISABLE_ADMIN = False # (optionally configuration if you want to disable change to True)
+
+```
+
+Create a new View that about handling call backs
+```python
+from payme.views import PaymeWebHookAPIView
+
+
+class PaymeCallBackAPIView(PaymeWebHookAPIView):
+
+
+    def handle_successfully_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the successful payment. You can override this method
+        """
+        print(f"Transaction successfully performed for this params: {params} and performed_result: {result}")
+
+    def handle_cancelled_payment(self, params, result, *args, **kwargs):
+        """
+        Handle the cancelled payment. You can override this method
+        """
+        print(f"Transaction cancelled for this params: {params} and cancelled_result: {result}")
+```
+
+Add a `payme` path to core of urlpatterns:
+
+```python
+from django.urls import path
+from django.urls import include
+
+from your_app.views import PaymeCallBackAPIView
+
+urlpatterns = [
+    ...
+    path("payment/update/", PaymeCallBackAPIView.as_view()),
+    ...
+]
+```
+
+Run migrations
+```shell
+python manage.py migrate
+```
+🎉 Congratulations you have been integrated merchant api methods with django, keep reading docs. After successfull migrations check your admin panel and see results what happened.
+
+## Payme Client SDK
+
+The Payme SDK provides a unified client interface for working with all Payme services.
+
+## Initialization
+
+Initialize the Payme client with your credentials:
+
+```python
+from payme import Payme
+
+# Basic initialization (for Cards API and Payment Links)
+payme = Payme(
+    payme_id="your-payme-id",
+    is_test_mode=True,  # Optional: defaults to False
+    license_api_key="your-license-key"  # Contact @muhammadali_me on Telegram
+)
+
+# Full initialization (for all features including Receipts API)
+payme = Payme(
+    payme_id="your-payme-id",
+    payme_key="your-payme-key",  # Required for Receipts API
+    is_test_mode=True,
+    license_api_key="your-license-key"
+)
+```
+
+---
+
+## Cards API
+
+Manage card tokenization and verification.
+
+### Create Card
+
+Create a new card token.
+
+```python
+response = payme.cards_create(
+    number="8600495473316478",
+    expire="0399",  # MMYY format
+    save=True,  # Optional: save card for future use
+    timeout=10  # Optional: request timeout in seconds
+)
+
+print(response.result.card.token)  # Card token
+print(response.result.card.number)  # Masked card number
+```
+
+### Get Verify Code
+
+Request a verification code for a card.
+
+```python
+response = payme.cards_get_verify_code(
+    token="card-token",
+    timeout=10
+)
+
+print(response.result.sent)  # True if code was sent
+print(response.result.phone)  # Phone number where code was sent
+```
+
+### Verify Card
+
+Verify a card with the code received via SMS.
+
+```python
+response = payme.cards_verify(
+    token="card-token",
+    code="666666",  # Code from SMS
+    timeout=10
+)
+
+print(response.result.card.verify)  # True if verified
+```
+
+### Check Card
+
+Check the status of a card.
+
+```python
+response = payme.cards_check(
+    token="card-token",
+    timeout=10
+)
+
+print(response.result.card.verify)  # Verification status
+```
+
+### Remove Card
+
+Remove a card token.
+
+```python
+response = payme.cards_remove(
+    token="card-token",
+    timeout=10
+)
+
+print(response.result.success)  # True if removed
+```
+
+### Test Cards
+
+Run comprehensive tests for card operations.
+
+```python
+payme.cards_test()
+```
+
+---
+
+## Receipts API
+
+Manage payment receipts (requires `payme_key`).
+
+### Create Receipt
+
+Create a new payment receipt.
+
+```python
+response = payme.receipts_create(
+    account={"order_id": 12345},
+    amount=50000,  # Amount in tiyins (50000 tiyins = 500 UZS)
+    description="Payment for order #12345",  # Optional
+    detail={  # Optional
+        "items": [
+            {"name": "Product 1", "price": 25000, "quantity": 1},
+            {"name": "Product 2", "price": 25000, "quantity": 1}
+        ]
+    },
+    timeout=10
+)
+
+print(response.result.receipt._id)  # Receipt ID
+```
+
+### Pay Receipt
+
+Pay a receipt using a card token.
+
+```python
+response = payme.receipts_pay(
+    receipts_id="receipt-id",
+    token="card-token",
+    timeout=10
+)
+
+print(response.result.receipt.state)  # Payment state (4 = paid)
+```
+
+### Send Receipt
+
+Send receipt details to a phone number.
+
+```python
+response = payme.receipts_send(
+    receipts_id="receipt-id",
+    phone="998901234567",
+    timeout=10
+)
+
+print(response.result.success)  # True if sent
+```
+
+### Cancel Receipt
+
+Cancel a receipt.
+
+```python
+response = payme.receipts_cancel(
+    receipts_id="receipt-id",
+    timeout=10
+)
+
+print(response.result.receipt.state)  # State (50 = cancelled)
+```
+
+### Check Receipt
+
+Check the status of a receipt.
+
+```python
+response = payme.receipts_check(
+    receipts_id="receipt-id",
+    timeout=10
+)
+
+print(response.result.state)  # Current state
+```
+
+### Get Receipt
+
+Get detailed information about a specific receipt.
+
+```python
+response = payme.receipts_get(
+    receipts_id="receipt-id",
+    timeout=10
+)
+
+print(response.result.receipt)  # Receipt details
+```
+
+### Get All Receipts
+
+Get all receipts within a time range.
+
+```python
+response = payme.receipts_get_all(
+    count=10,  # Number of receipts to retrieve
+    from_=1609459200000,  # Start timestamp (milliseconds)
+    to=1640995200000,  # End timestamp (milliseconds)
+    offset=0,  # Pagination offset
+    timeout=10
+)
+
+for receipt in response.result:
+    print(receipt._id, receipt.amount)
+```
+
+### Set Fiscal Data
+
+Set fiscal data for a receipt.
+
+```python
+response = payme.receipts_set_fiscal_data(
+    receipt_id="receipt-id",
+    qr_code_url="https://ofd.uz/check?t=123&s=456&r=789&c=2024",
+    timeout=10
+)
+
+print(response.result.success)  # True if set
+```
+
+### Test Receipts
+
+Run comprehensive tests for receipt operations.
+
+```python
+payme.receipts_test()
+```
+
+---
+
+## Payment Initialization
+
+Generate payment links for customers.
+
+### Generate Pay Link
+
+Generate a payment link for checkout.
+
+```python
+pay_link = payme.generate_pay_link(
+    id=12345,  # Account ID
+    amount=5000,  # Amount in UZS (will be converted to tiyins)
+    return_url="https://example.com/success"
+)
+
+print(pay_link)
+# Output: https://checkout.paycom.uz/bT1...
+```
+
+### Generate Fallback Link
+
+Generate a fallback payment link with custom form fields.
+
+```python
+fallback_link = payme.generate_fallback_link(
+    form_fields={  # Optional
+        "driver_id": 12345,
+        "amount": 1000
+    }
+)
+
+print(fallback_link)
+# Output: https://payme.uz/fallback/merchant/?id=...&driver_id=12345&amount=1000
+```
+
+**Note:** The fallback ID is different from the merchant ID. Contact the Payme team to get your fallback ID.

payme_pkg-3.3.0.dist-info/RECORD

@@ -0,0 +1,37 @@
+payme/__init__.py,sha256=dzLIyA9kQl0sO6z9nHkZDTjkfiI1BepdifKtJbjX2Cw,46
+payme/admin.cpython-312-darwin.so,sha256=yaIXBW-TM6SELiT7rf4rPm7msanEmXlYtOM3fMvYPco,108920
+payme/apps.cpython-312-darwin.so,sha256=6RXXplsaTcSEAl7RxO8Nw5IWnvnORgA7q-7A7TFBAqg,151352
+payme/const.cpython-312-darwin.so,sha256=Srk7IqsxeYeK9CfuvS5dteq_UQvQ6wQWLj4uuxXydC0,107704
+payme/licensing.cpython-312-darwin.so,sha256=JLl9iiQr07_uJ8HMkKEDvmGoDhid4Wbx4mVA7LfFr7o,169392
+payme/models.cpython-312-darwin.so,sha256=sRWcQKqY2SeNj4amy1mH7_ZzH16vgTcLEMohTol0CBY,223552
+payme/urls.cpython-312-darwin.so,sha256=7NjGpumEABiiQ1ESdxWnj3mWoqvq6PSQMGB12vQxc74,90968
+payme/util.cpython-312-darwin.so,sha256=mUOwhV6CSQ-CWeL_oUWCRCdB4V6WkUISPadt9C3NgLw,151688
+payme/classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/classes/cards.cpython-312-darwin.so,sha256=uVUJURDyxolC6uwJHxCqn6Y9dcWhpyam4dERnnChh1M,223944
+payme/classes/client.py,sha256=v0wb4ZhokuhpfTxZ7bj-UBiPd2l1Cd8GxUs8Icb3oVc,10191
+payme/classes/http.cpython-312-darwin.so,sha256=sKiAoYOOn29KgEQeE1mCQyCjxBR8Zt81HaKBs-dUEWM,186296
+payme/classes/initializer.cpython-312-darwin.so,sha256=kLWuIhkApbHQL27v6_tkXF1kaf8Mo1sZYrNohqPJsCc,188816
+payme/classes/receipts.cpython-312-darwin.so,sha256=HkP5y4StWf_ZvL5XUGMhRtwMK3oR-9dY5EOFB_PIocs,294624
+payme/exceptions/__init__.py,sha256=HoBFnDA3eW_xWZiFlonJK4vhBDTsuik91tvgzXTy8KA,94
+payme/exceptions/general.cpython-312-darwin.so,sha256=K4gdSOQQx76pkADglwEnG-rvbIbyjD97PXR6S7ksgX8,366832
+payme/exceptions/webhook.cpython-312-darwin.so,sha256=xf8Aspf3W0ZYJTyo19A-wofDPOhX0pbswdAJHbS-tb8,186624
+payme/migrations/0001_initial.py,sha256=jdtGB6bN-Za6N9XU8IuWsa5FbonGIRH5ro9xHwT7JmU,2128
+payme/migrations/0002_paymetransactions_fiscal_data.py,sha256=z-gxPP3IgN-XNPx6DEZUQ4E1XZceVnnpvUTcSkcv70c,395
+payme/migrations/0003_alter_paymetransactions_fiscal_data.py,sha256=Ish4Seup9pdEM0g4q4RQKrvUOWB2DXPN0RmIScKI2IQ,410
+payme/migrations/0004_alter_paymetransactions_account_id.py,sha256=Kzihw4-HHBG43fZ2WU-qLLU-kxN-plfS3mLeIEZGKxA,417
+payme/migrations/0005_alter_paymetransactions_amount.py,sha256=q1oXti3OVmRi0C7fyuD_BgDtH_XW1lMN_rXB72976S8,442
+payme/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/types/request/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payme/types/response/__init__.py,sha256=GAj5pjZ9oIO67T6YMiPd1fhTIvGrPfTv96tykfeChQc,81
+payme/types/response/cards.py,sha256=i1IS-oe9XGRFggiHvNZmEbbILUqAw3NE7Ca5FO4kATQ,2121
+payme/types/response/receipts.py,sha256=aHsK5fk79xid00gbLl49VrimMn2iqI3gnfEuuJq592g,4517
+payme/types/response/webhook.py,sha256=E8IVD683T7wra4OxUWq5T6y7HGpjwOVk8ak0tS0b-_o,3084
+payme/views/__init__.py,sha256=qjCG2-ZhrOMEasCisTWAAqSNapiim9oMjPcGb1Ha5dw,92
+payme/views/base.cpython-312-darwin.so,sha256=Yc1cRJKunzEdDZqZvPnUQH-hI-RiEs9e6mzUH2eiKXw,380904
+payme/views/payme.py,sha256=hK1-AQgvxGn2GagwfRaDzrs0XTt6_Zft8EOxFmyvzYA,1241
+payme_pkg-3.3.0.dist-info/licenses/LICENSE.txt,sha256=75dBVYmbzWUhwtaB1MSZfj-M-PGaMmeT9UVPli2-ZJ0,1086
+payme_pkg-3.3.0.dist-info/METADATA,sha256=evjXCV04rBurIyM5rxJ6cdoN1LSAS8JdISRH_421E08,10351
+payme_pkg-3.3.0.dist-info/WHEEL,sha256=_N1vyLgwJ10g4JxFsp-IfU42zGJgf-DUqwfdbV1YvEM,115
+payme_pkg-3.3.0.dist-info/top_level.txt,sha256=8mN-hGAa38pWbhrKHFs9CZywPCdidhMuwPKwuFJa0qw,6
+payme_pkg-3.3.0.dist-info/RECORD,,

payme_pkg-3.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_10_13_universal2
+

payme_pkg-3.3.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,24 @@
+MIT License
+-----------
+
+Copyright (c) 2023 Muhammadali Akbarov
+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.

payme_pkg-3.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+payme