payme-pkg 2.1__tar.gz → 2.5.3__tar.gz

{payme-pkg-2.1 → payme-pkg-2.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: payme-pkg
-Version: 2.1
+Version: 2.5.3
 Summary: UNKNOWN
 Home-page: https://github.com/Muhammadali-Akbarov/payme-pkg
 Author: Muhammadali Akbarov

{payme-pkg-2.1 → payme-pkg-2.5.3}/README.md

@@ -1,43 +1,54 @@
 # Payme Uzbekistan Integration Uzcard and Humo
 <p align="center">
-    <img style="width: 70%;" src="https://www.gazeta.uz/media/img/2019/07/GDpmEM15631750293941_b.jpg"></img>
+<a href="https://youtu.be/r2RO3kJVP7g">
+<img style="width: 60%;" src="https://i.postimg.cc/WbD32bHC/payme-pkg-demo-m4a.gif">
+</a>
 </p>
-
+Support Group - <a href="https://t.me/+Ng1axYLNyBAyYTRi">Telegram</a> <br/>
+YouTube - <a href="https://youtu.be/sJORIyykHcw">Watch Video</a><br/>
+Implementation Sample - https://github.com/PayTechUz/payme-sample
 
 ## Installation
 
+```shell
+pip install payme-pkg
 ```
-$ pip install payme-pkg
-```
+
 ### Test-Credentials
+
 ```
-Card Numer: 8600 4954 7331 6478 Expire Date: 03/99 SMS Code: 666666 
-Card Numer: 8600 0691 9540 6311 Expire Date: 03/99 SMS Code: 666666 
+Card Numer: 8600 4954 7331 6478 Expire Date: 03/99 SMS Code: 666666
+Card Numer: 8600 0691 9540 6311 Expire Date: 03/99 SMS Code: 666666
 ```
 
 ## Documentation
-  * [Merchant API](#merchant-api)
-  * Subscribe Cards
-    * [Cards Create](#cards-create)
-    * [Cards Get Verify Code](#cards-get-verify-code)
-    * [Cards Verify](#cards-verify)
-    * [Cards Check](#cards-check)
-    * [Cards Remove](#cards-remove)
-   
-  * Subscribe Receipts
-    * [Receipts Create](#receipts-create)
-    * [Receipts Pay](#receipts-pay)
-    * [Receipts Send](#receipts-send)
-    * [Receipts Cancel](#receipts-cancel)
-    * [Receipts Check](#receipts-check)
-    * [Receipts Get](#receipts-get)
-    * [Receipts Get All ](#receipts-get-all)
+
+- [Merchant API](#merchant-api)
+- [Generate Pay Link](#generate-pay-link)
+
+- Subscribe Cards
+
+  - [Cards Create](#cards-create)
+  - [Cards Get Verify Code](#cards-get-verify-code)
+  - [Cards Verify](#cards-verify)
+  - [Cards Check](#cards-check)
+  - [Cards Remove](#cards-remove)
+
+- Subscribe Receipts
+  - [Receipts Create](#receipts-create)
+  - [Receipts Pay](#receipts-pay)
+  - [Receipts Send](#receipts-send)
+  - [Receipts Cancel](#receipts-cancel)
+  - [Receipts Check](#receipts-check)
+  - [Receipts Get](#receipts-get)
+  - [Receipts Get All ](#receipts-get-all)
 
 # Merchant API
 
 ## Installation to Django
 
 Add `'payme'` in to your settings.
+
 ```python
 INSTALLED_APPS = [
     ...
@@ -45,7 +56,9 @@ INSTALLED_APPS = [
     ...
 ]
 ```
+
 Add `'payme'` credentials inside to settings.
+
 ```python
 PAYME: dict = {
     'PAYME_ID': 'payme-id',
@@ -55,51 +68,102 @@ PAYME: dict = {
     'PAYME_MIN_AMOUNT': 'payme-min-amount', # integer field
     'PAYME_ACCOUNT': 'order-id',
 }
+
+ORDER_MODEL = 'your_app.models.Your_Order_Model'
 ```
+
+Create a new View that about handling call backs
+```python
+from payme.views import MerchantAPIView
+
+
+class PaymeCallBackAPIView(MerchantAPIView):
+    def create_transaction(self, order_id, action, *args, **kwargs) -> None:
+        print(f"create_transaction for order_id: {order_id}, response: {action}")
+
+    def perform_transaction(self, order_id, action, *args, **kwargs) -> None:
+        print(f"perform_transaction for order_id: {order_id}, response: {action}")
+
+    def cancel_transaction(self, order_id, action, *args, **kwargs) -> None:
+        print(f"cancel_transaction for order_id: {order_id}, response: {action}")
+```
+
 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("payments/", include("payme.urls"))
+    path("payments/merchant/", 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.
+
+## Generate Pay Link
+
+Example to generate link:
+
+- Input
+
+```python
+from pprint import pprint
+
+from payme.methods.generate_link import GeneratePayLink
+
+pay_link = GeneratePayLink(
+  order_id=999,
+  amount=9999
+).generate_link()
+
+pprint(pay_link)
 ```
-$ python manage.py migrate
+
+- Output
+
+```
+Link: https://checkout.paycom.uz/bT01ZTczMGU4ZTBiODUyYTQxN2FhNDljZWI7YWMub3JkZXItaWQ9OTk5O2E9OTk5OTtjPXlvdXItY2FsbGJhY2stdXJs
 ```
-🎉 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.
 
 ## Cards Create
+
 Example for cards create method for to generate token from card:
 
-* Request
+- Request
 
-```
+```python
 from pprint import pprint
 
 from payme.cards.subscribe_cards import PaymeSubscribeCards
 
-
 client = PaymeSubscribeCards(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb"
+    paycom_id=$paycom_id
 )
 
-resp = client._cards_create(
+resp = client.cards_create(
     number="8600069195406311",
     expire="0399",
-    save=True,
+    save=True
 )
 
 pprint(resp)
 ```
-* Response
 
-```
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "result": {
@@ -116,9 +180,12 @@ pprint(resp)
 ```
 
 ## Cards Get Verify Code
+
 Example for cards get verify:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.cards.subscribe_cards import PaymeSubscribeCards
@@ -126,17 +193,19 @@ from payme.cards.subscribe_cards import PaymeSubscribeCards
 
 client = PaymeSubscribeCards(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb"
+    paycom_id=$paycom_id
 )
 
-resp = client._card_get_verify_code(
+resp = client.card_get_verify_code(
     token="630e5ffdd15d8d8d093b379b_2fsaoABWafecn20kofV4PFafFZjeGDWS9adM1PmboQaEZbbaxMcnaskctMbU9Iv8qgrOuKGz8SnjvZvYXDK64m1eS9gA5jZ7BBRaQybMXrDPtFPJ1fwek5B1KoIv5cMiCWYXj7ezpYEdJAKTIQw0Np9HsTXjqco4gQG3m8MOfeH9ovkdm66O6yj45oKXRmJyAK5i0SchXNNomACH3Oq80KyoRE1VoBRxvoKyMkOx0xcepXovxK9d3v26a8z7UtyokwY33N8MupviM3A5WHB5Xh35WZJJyFnxTSi1vvnYnG7uVd6Bb1GjV2yAHnimss8aEZGW5V7ZiPrhf8r6WJAeHciYDGK3msRKZJBQTfjgOdE9tGrEnMezVkxr1JXX0xSn5qqec2"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "result": {
@@ -148,9 +217,12 @@ pprint(resp)
 ```
 
 ## Cards Verify
+
 Example for cards verify method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.cards.subscribe_cards import PaymeSubscribeCards
@@ -158,18 +230,20 @@ from payme.cards.subscribe_cards import PaymeSubscribeCards
 
 client = PaymeSubscribeCards(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb"
+    paycom_id=$paycom_id
 )
 
-resp = client._cards_verify(
+resp = client.cards_verify(
     verify_code="666666",
     token="630e691fd15d8d8d093b379c_70mKyzqS8d1wTWzovIGjt9dKmjpn1KI8Y9XakPrfpbUASTBaZYbC1DjDcjYRmuNJep9gZrTRtHyEGBQYmBaPufuozF51bv4qEPsQnodq1VcD7tYyREwUXjMXXZUeu7Ek0REQCekCvVHX6rtNBpb4vtViJoNVjp94XpTqu0Bn3yYYb0CHu951wFydzRsieGxjGNrvx1oKyBcq0CdOUwoffRIt2VPvx5R2aVmc6ahwyhn387FEEcpO1PnjIJkWKTBWdI35ZPQnb1u1oss5aPg06E279THXRkoTThixbeqiD2JkWSXweNVGGDhTS30V4j61G3NWEPO2H3k4uFmCjjIQSzx4TxKzUgHg1i2q953PRUGjT4JZBRHMDxaN5tWuctEMNmY06p"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "result": {
@@ -186,9 +260,12 @@ pprint(resp)
 ```
 
 ## Cards Check
+
 Example for cards check:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.cards.subscribe_cards import PaymeSubscribeCards
@@ -196,17 +273,19 @@ from payme.cards.subscribe_cards import PaymeSubscribeCards
 
 client = PaymeSubscribeCards(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb"
+    paycom_id=$paycom_id
 )
 
-resp = client._cards_check(
+resp = client.cards_check(
     token="630e691fd15d8d8d093b379c_70mKyzqS8d1wTWzovIGjt9dKmjpn1KI8Y9XakPrfpbUASTBaZYbC1DjDcjYRmuNJep9gZrTRtHyEGBQYmBaPufuozF51bv4qEPsQnodq1VcD7tYyREwUXjMXXZUeu7Ek0REQCekCvVHX6rtNBpb4vtViJoNVjp94XpTqu0Bn3yYYb0CHu951wFydzRsieGxjGNrvx1oKyBcq0CdOUwoffRIt2VPvx5R2aVmc6ahwyhn387FEEcpO1PnjIJkWKTBWdI35ZPQnb1u1oss5aPg06E279THXRkoTThixbeqiD2JkWSXweNVGGDhTS30V4j61G3NWEPO2H3k4uFmCjjIQSzx4TxKzUgHg1i2q953PRUGjT4JZBRHMDxaN5tWuctEMNmY06p"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "result": {
@@ -221,10 +300,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Cards Remove
+
 Example for cards create method for to generate token from card:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.cards.subscribe_cards import PaymeSubscribeCards
@@ -232,17 +315,19 @@ from payme.cards.subscribe_cards import PaymeSubscribeCards
 
 client = PaymeSubscribeCards(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb"
+    paycom_id=$paycom_id
 )
 
-resp = client._cards_check(
+resp = client.cards_remove(
     token="630e691fd15d8d8d093b379c_70mKyzqS8d1wTWzovIGjt9dKmjpn1KI8Y9XakPrfpbUASTBaZYbC1DjDcjYRmuNJep9gZrTRtHyEGBQYmBaPufuozF51bv4qEPsQnodq1VcD7tYyREwUXjMXXZUeu7Ek0REQCekCvVHX6rtNBpb4vtViJoNVjp94XpTqu0Bn3yYYb0CHu951wFydzRsieGxjGNrvx1oKyBcq0CdOUwoffRIt2VPvx5R2aVmc6ahwyhn387FEEcpO1PnjIJkWKTBWdI35ZPQnb1u1oss5aPg06E279THXRkoTThixbeqiD2JkWSXweNVGGDhTS30V4j61G3NWEPO2H3k4uFmCjjIQSzx4TxKzUgHg1i2q953PRUGjT4JZBRHMDxaN5tWuctEMNmY06p"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "result": {
@@ -250,10 +335,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Create
+
 Example for receipts create method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -261,19 +350,21 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._receipts_create(
+resp = rclient.receipts_create(
     amount=10000,
     order_id="1"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "result": {
@@ -326,10 +417,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Pay
+
 Example for receipts pay method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -337,11 +432,11 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._receipts_pay(
+resp = rclient.receipts_pay(
     invoice_id="631186b6c4420cbf2712a243",
     token="63118a5dd15d8d8d093b37b7_X2j34OIJPnROfsgzYZCZ0w7OcC50zzwiowTsotEVO1uUbxkzaDrvdOno6jicQTrcRmxvibxrye4vUS3AynTNPaPCTGpfk3RCKmT9NaOAyyTmctAjWsjwvqGR5XUzAP1Xcx12GkhuQi6VJ4BeaIXOokSRu06rRjaivmJQ8HTiJiR9b3OmZtrhkIRNcNXnnp9zYm1mFP4BuqGpS8BMnY0ASIE6ffxWykjgBcDTAfWBFt4mg7O9Dsvx0aj3IB8z3RIbZYtDZJnUVhCZrwW7ONVI9uEAdxNthorjO6PbV7TQ8XCjrztgGf6uCtOwwxasiIUVZN6tCVDk8A8NvVSUzUHXQHVkaPn5heJNa3K4WsffIckq7SwMbiw3UbawipeZKyD3iwk1Km",
     phone="998901304527"
@@ -349,8 +444,10 @@ resp = rclient._receipts_pay(
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "id": 123,
@@ -407,10 +504,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Send
+
 Example for receipts send method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -418,19 +519,21 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._receipts_send(
+resp = rclient.receipts_send(
     invoice_id="631186b6c4420cbf2712a243",
     phone="998901304527"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "id": 123,
@@ -439,10 +542,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Cancel
+
 Example for receipts cancel method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -450,18 +557,20 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._receipts_cancel(
+resp = rclient.receipts_cancel(
     invoice_id="63119303c4420cbf2712a245"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "id": 123,
@@ -519,10 +628,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Check
+
 Example for receipts check method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -530,18 +643,20 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._receipts_check(
+resp = rclient.receipts_check(
     invoice_id="63119303c4420cbf2712a245"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "id": 123,
@@ -550,10 +665,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Get
+
 Example for receipts get method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -561,18 +680,20 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._reciepts_get(
+resp = rclient.reciepts_get(
     invoice_id="6311946bc4420cbf2712a247"
 )
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "id": 123,
@@ -626,10 +747,14 @@ pprint(resp)
   }
 }
 ```
+
 ## Receipts Get All
+
 Example for receipts get all method:
-* Request
-```
+
+- Request
+
+```python
 from pprint import pprint
 
 from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
@@ -637,11 +762,11 @@ from payme.receipts.subscribe_receipts import PaymeSubscribeReceipts
 
 rclient = PaymeSubscribeReceipts(
     base_url="https://checkout.test.paycom.uz/api/",
-    paycom_id="5e730e8e0b852a417aa49ceb",
-    paycom_key="#MWnwHNYATJo%W@XvO5nISiY&mG7PEuzDX18"
+    paycom_id=$paycom_id,
+    paycom_key=$paycom_key
 )
 
-resp = rclient._reciepts_get_all(
+resp = rclient.reciepts_get_all(
     count=2,
     _from=1636398000000,
     to=1636398000000,
@@ -650,8 +775,10 @@ resp = rclient._reciepts_get_all(
 
 pprint(resp)
 ```
-* Response
-```
+
+- Response
+
+```json
 {
   "jsonrpc": "2.0",
   "id": 123,

payme-pkg-2.5.3/lib/payme/admin.py

@@ -0,0 +1,11 @@
+from django.contrib import admin
+
+from payme.models import CUSTOM_ORDER
+from payme.models import Order as DefaultOrderModel
+
+from payme.models import MerchatTransactionsModel
+
+if not CUSTOM_ORDER:
+    admin.site.register(DefaultOrderModel)
+
+admin.site.register(MerchatTransactionsModel)

{payme-pkg-2.1 → payme-pkg-2.5.3}/lib/payme/apps.py

@@ -2,5 +2,9 @@ from django.apps import AppConfig
 
 
 class PaymeConfig(AppConfig):
+    """
+    PaymeConfig AppConfig \
+        That is used to configure the payme application with django settings.
+    """
     default_auto_field = 'django.db.models.BigAutoField'
     name = 'payme'

payme-pkg-2.5.3/lib/payme/cards/__init__.py

@@ -0,0 +1 @@
+from .import subscribe_cards