solidgate-sdk 0.3.2__py3-none-any.whl

solidgate/__init__.py

@@ -0,0 +1,2 @@
+from .api_client import ApiClient
+from .api_client import MerchantData

solidgate/api_client.py

@@ -0,0 +1,129 @@
+import base64
+import hashlib
+import hmac
+import json
+from datetime import datetime
+from typing import Generator
+
+import requests
+
+from solidgate.encryption import AESCipher
+from solidgate.model import MerchantData
+
+
+class ApiClient:
+    BASE_SOLID_GATE_API_URI = 'https://pay.solidgate.com/api/v1/'
+    BASE_RECONCILIATION_API_URI = 'https://reports.solidgate.com/'
+
+    RECONCILIATION_ORDERS_PATH = 'api/v2/reconciliation/orders'
+    RECONCILIATION_CHARGEBACKS_PATH = 'api/v2/reconciliation/chargebacks'
+
+    RECONCILIATION_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
+
+    def __init__(self, merchant_id: str,
+                 private_key: str,
+                 base_solid_gate_api_uri: str = BASE_SOLID_GATE_API_URI,
+                 base_reconciliations_api_uri: str = BASE_RECONCILIATION_API_URI):
+        self.__merchant_id = merchant_id
+        self.__private_key = private_key
+        self.__base_solid_gate_api_uri = base_solid_gate_api_uri
+        self.__base_reconciliations_api_uri = base_reconciliations_api_uri
+
+    def charge(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('charge', attributes)
+
+    def recurring(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('recurring', attributes)
+
+    def resign(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('resign', attributes)
+
+    def status(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('status', attributes)
+
+    def refund(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('refund', attributes)
+
+    def auth(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('auth', attributes)
+
+    def void(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('void', attributes)
+
+    def settle(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('settle', attributes)
+
+    def arn_code(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('arn-code', attributes)
+
+    def apple_pay(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('apple-pay', attributes)
+
+    def google_pay(self, attributes: dict) -> requests.models.Response:
+        return self.__send_solidgate_request('google-pay', attributes)
+
+    def form_merchant_data(self, attributes: dict) -> FormInitDTO:
+        payment_intent = AESCipher(self.__private_key).encrypt(self.__convert_request_attributes_to_str(attributes))
+        signature = self.__generate_signature(payment_intent)
+        form_init_dto = FormInitDTO(payment_intent=payment_intent, publicKey=self.__merchant_id, signature=signature)
+        return form_init_dto
+
+    def form_update(self, attributes: dict) -> FormUpdateDTO:
+        partial_intent = AESCipher(self.__private_key).encrypt(self.__convert_request_attributes_to_str(attributes))
+        signature = self.__generate_signature(partial_intent)
+        form_update_dto = FormUpdateDTO(partial_intent=partial_intent, signature=signature)
+        return form_update_dto
+
+    def form_resign(self, attributes: dict) -> FormInitDTO:
+        resign_intent = AESCipher(self.__private_key).encrypt(self.__convert_request_attributes_to_str(attributes))
+        signature = self.__generate_signature(resign_intent)
+        form_resign_dto = FormResignDTO(resign_intent=resign_intent, publicKey=self.__merchant_id, signature=signature)
+        return form_resign_dto
+
+    def order_reconciliation(self, date_from: datetime, date_to: datetime) -> Generator:
+        return self.__send_reconciliation_request(self.RECONCILIATION_ORDERS_PATH, date_from, date_to)
+
+    def chargeback_reconciliation(self, date_from: datetime, date_to: datetime) -> Generator:
+        return self.__send_reconciliation_request(self.RECONCILIATION_CHARGEBACKS_PATH, date_from, date_to)
+
+    def __generate_signature(self, data: str) -> str:
+        encrypto_data = (self.__merchant_id + data + self.__merchant_id).encode('utf-8')
+        sign = hmac.new(self.__private_key.encode('utf-8'), encrypto_data, hashlib.sha512).hexdigest()
+        return base64.b64encode(sign.encode('utf-8')).decode('utf-8')
+
+    def __send_solidgate_request(self, method: str, attributes: dict) -> requests.models.Response:
+        full_url = self.__base_solid_gate_api_uri + method
+        return self.__send_request(full_url, attributes)
+
+    def __send_reconciliation_request(self, path: str, date_from: datetime, date_to: datetime) -> Generator:
+        full_url = self.__base_reconciliations_api_uri + path
+        attributes = {'date_from': date_from.strftime(self.RECONCILIATION_DATETIME_FORMAT),
+                      'date_to': date_to.strftime(self.RECONCILIATION_DATETIME_FORMAT)}
+        while True:
+            try:
+                response = self.__send_request(full_url, attributes)
+            except requests.exceptions.RequestException as err:
+                raise Exception("Exception during request:", err)
+
+            if 200 <= response.status_code < 300:
+                response_content = json.loads(response.content)
+                for order in response_content['orders']:
+                    yield order
+
+                attributes['next_page_iterator'] = response_content['metadata']['next_page_iterator']
+                if not attributes['next_page_iterator']:
+                    break
+            else:
+                raise Exception('Request is not successful!')
+
+    def __send_request(self, path: str, attributes: dict) -> requests.models.Response:
+        body = self.__convert_request_attributes_to_str(attributes)
+        headers = {'Content-Type': 'application/json',
+                   'Accept': 'application/json',
+                   'Merchant': self.__merchant_id,
+                   'Signature': self.__generate_signature(body)}
+        return requests.post(path, headers=headers, json=attributes)
+
+    @staticmethod
+    def __convert_request_attributes_to_str(attributes: dict) -> str:
+        return json.dumps(attributes)

solidgate/encryption.py

@@ -0,0 +1,19 @@
+import base64
+
+from Crypto import Random
+from Crypto.Cipher import AES
+from Crypto.Util.Padding import pad
+
+
+class AESCipher:
+    MAX_KEY_LEN = 32
+
+    def __init__(self, key):
+        self.__block_size = AES.block_size
+        self.__key = key[:self.MAX_KEY_LEN].encode()
+
+    def encrypt(self, raw: str) -> str:
+        raw = pad(raw.encode(), self.__block_size, style='pkcs7')
+        iv = Random.new().read(self.__block_size)
+        cipher = AES.new(self.__key, AES.MODE_CBC, iv)
+        return base64.urlsafe_b64encode(iv + cipher.encrypt(raw)).decode('utf-8')

solidgate/model.py

@@ -0,0 +1,16 @@
+class FormInitDTO:
+    def __init__(self, payment_intent: str, publicKey: str, signature: str):
+        self.payment_intent = payment_intent
+        self.merchant = publicKey
+        self.signature = signature
+
+class FormUpdateDTO:
+    def __init__(self, partial_intent: str, signature: str):
+        self.partial_intent = partial_intent
+        self.signature = signature
+
+class FormResignDTO:
+    def __init__(self, resignIntent: str, publicKey: str, signature: str):
+        self.resign_intent = resignIntent
+        self.merchant = publicKey
+        self.signature = signature

solidgate_sdk-0.3.2.dist-info/METADATA

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: solidgate-sdk
+Version: 0.3.2
+Summary: Python API SDK for SolidGate payment gateway
+Home-page: https://api-docs.solidgate.com/
+Author: SolidGate
+Author-email: info@solidgate.com
+Classifier: Programming Language :: Python :: 3.7
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: requests
+Requires-Dist: pycryptodome
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# Solidgate API
+
+[![PyPI version](https://badge.fury.io/py/solidgate-sdk.svg)](https://badge.fury.io/py/solidgate-sdk)
+
+Python SDK provides API options for integrating Solidgate’s payment orchestrator into your Python applications.
+
+Check our
+* <a href="https://docs.solidgate.com/" target="_blank">Payment guide</a> to understand business value better
+* <a href="https://api-docs.solidgate.com/" target="_blank">API Reference</a> to find more examples of usage
+
+## Structure
+
+<table style="width: 100%; background: transparent;">
+  <colgroup>
+    <col style="width: 50%;">
+    <col style="width: 50%;">
+  </colgroup>
+  <tr>
+    <th>SDK for Python contains</th>
+    <th>Table of contents</th>
+  </tr>
+  <tr>
+    <td>
+      <ul>
+        <li>
+          <code>solidgate/</code> – main library source code for development
+          <ul>
+            <li><code>__init__.py</code> – initializes the SDK package for importing</li>
+            <li><code>api_client.py</code> – main file for API integration and HTTP request handling</li>
+            <li><code>encryption.py</code> – library for encryption-related operations</li>
+            <li><code>model.py</code> – defines data structures for payment attributes and responses</li>
+          </ul>
+        </li>
+        <li><code>setup.py</code> – script for managing dependencies and library imports</li>
+      </ul>
+    </td>
+    <td>
+        <a href="https://github.com/solidgate-tech/python-sdk?tab=readme-ov-file#requirements">Requirements</a><br>
+        <a href="https://github.com/solidgate-tech/python-sdk?tab=readme-ov-file#installation">Installation</a><br>
+        <a href="https://github.com/solidgate-tech/python-sdk?tab=readme-ov-file#usage">Usage</a><br>
+        <a href="https://github.com/solidgate-tech/python-sdk?tab=readme-ov-file#errors">Errors</a><br>
+    </td>
+  </tr>
+</table>
+
+<br>
+
+## Requirements
+
+* **Python**: 3.7 or later
+* **Packages**: `requests` library
+* **Solidgate account**: Public and secret key (request via <a href="mailto:sales@solidgate.com">sales@solidgate.com</a>)
+
+<br>
+
+## Installation
+
+To start using the Python SDK:
+
+1. Ensure you have your public and secret key.
+2. Install the SDK in your project using pip:
+   ```bash
+   pip install solidgate-card-sdk
+   ```
+3. Import the classes into your project:
+    ```
+   from solidgate import ApiClient
+   client = ApiClient(public_key='YourMerchantId', secret_key='YourPrivateKey')
+   ```
+4. Use test credentials for integration testing. After successful testing, switch to production credentials.
+
+<br>
+
+## Usage
+
+### Charge a payment
+
+Create a class instance of the `ApiClient` class.
+
+```
+from solidgate import ApiClient
+
+client = ApiClient(public_key, secret_key)
+```
+
+- `public_key` - unique merchant identification
+- `secret_key` - secret code for request signature, it is provided at the moment of merchant registration
+
+### Resign form
+
+```python
+response = client.form_resign({'order_id': '12345'})
+```
+
+<br>
+
+## Errors
+
+Handle <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">errors</a>.
+
+```python
+try:
+    response = client.charge({...})
+except Exception as e:
+    print(e)
+```
+
+---
+
+Looking for help? <a href="https://support.solidgate.com/support/tickets/new" target="_blank">Contact us</a> <br>
+Want to contribute? <a href="https://github.com/solidgate-tech/python-sdk/pulls" target="_blank">Submit a pull request</a>

solidgate_sdk-0.3.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+solidgate/__init__.py,sha256=nOvLT2_gmMOLcDLEdJIDCc_ED5udWhR0858SNOOIp_s,71
+solidgate/api_client.py,sha256=OpOItg46-kDzV47Qwh8x6M4DPU4ELr19kPiLkSqvs1I,6237
+solidgate/encryption.py,sha256=CjLdl11PxDuSb-RG-sp1WpIMjWd4gBjkYWVNas3MfcU,567
+solidgate/model.py,sha256=u6rq_bHppf9wSF9Szz7yDDm8C8nO0c4dAGbnXBFReeI,580
+solidgate_sdk-0.3.2.dist-info/licenses/LICENSE.md,sha256=Gjp7q0zwHb904tsXGdqKf7bNpkNUCOgoUeDihfIfCFY,609
+solidgate_sdk-0.3.2.dist-info/METADATA,sha256=E8FpzHRNnj3BBTMDfWVrvGD3YVUsXCRwlpacsRDlULs,4094
+solidgate_sdk-0.3.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+solidgate_sdk-0.3.2.dist-info/top_level.txt,sha256=g77pQ7dBSpjiJQJiDcDjyofS81wrd2jDAfTNlqxhAd4,10
+solidgate_sdk-0.3.2.dist-info/RECORD,,

solidgate_sdk-0.3.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

solidgate_sdk-0.3.2.dist-info/licenses/LICENSE.md

@@ -0,0 +1,13 @@
+Apache License, Version 2.0
+
+Copyright 2015 - GTWS Tech Limited (https://solidgate.com/)
+
+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.

solidgate_sdk-0.3.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+solidgate