qpay-client 0.1.0__tar.gz

qpay_client-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: qpay-client
+Version: 0.1.0
+Summary: Async qpay payment API client
+Author: Amraa1
+Author-email: Amraa1 <amarsanaaganbaatar0409@gmail.com>
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Package description
+Features I like to add:
+* Async and sync client
+* Provide ways for users to quickly create a client and start testing
+* Provide ways for users to optimize and prepare for prod env
+* qpay logs
+* 
+
+# QPAY developer doc
+https://developer.qpay.mn/

qpay_client-0.1.0/README.md

@@ -0,0 +1,10 @@
+# Package description
+Features I like to add:
+* Async and sync client
+* Provide ways for users to quickly create a client and start testing
+* Provide ways for users to optimize and prepare for prod env
+* qpay logs
+* 
+
+# QPAY developer doc
+https://developer.qpay.mn/

qpay_client-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "qpay-client"
+version = "0.1.0"
+description = "Async qpay payment API client"
+readme = "README.md"
+authors = [
+    { name = "Amraa1", email = "amarsanaaganbaatar0409@gmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "httpx>=0.28.1",
+    "pydantic>=2.11.7",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.14,<0.9.0"]
+build-backend = "uv_build"

qpay_client-0.1.0/src/qpay_client/__init__.py

@@ -0,0 +1,4 @@
+from .v2.qpay_client import QPayClient
+
+
+__all__ = ["QPayClient"]

qpay_client-0.1.0/src/qpay_client/v2/error.py

@@ -0,0 +1,23 @@
+class QPayError(Exception):
+    """
+    Raised when Qpay server returns error
+    """
+
+    def __init__(self, *, status_code: int, error_key: str) -> None:
+        self.exception_message = f"status_code: {status_code}, error_key: {error_key}"
+        super().__init__(self.exception_message)
+        self.status_code = status_code
+        self.error_key = error_key
+
+    def __repr__(self) -> str:
+        return self.exception_message
+
+
+class ClientConfigError(Exception):
+    """
+    Raised when the client is configured wrong.
+    """
+
+    def __init__(self, *attr) -> None:
+        self.exception_message = f"incorrect attributes: {attr}"
+        super().__init__(self.exception_message)

qpay_client-0.1.0/src/qpay_client/v2/qpay_client.py

@@ -0,0 +1,273 @@
+import os
+from httpx import AsyncClient, BasicAuth, Response
+import time
+from .schemas import (
+    InvoiceCreateRequest,
+    InvoiceCreateSimpleRequest,
+    Payment,
+    PaymentCheckRequest,
+    PaymentCheckResponse,
+    CreateInvoiceResponse,
+    TokenResponse,
+    PaymentListRequest,
+    EbarimtCreateRequest,
+    Ebarimt,
+)
+from .error import QPayError, ClientConfigError
+from typing import Optional
+import enum
+import logging
+
+
+class Environment(enum.Enum):
+    sandbox = 1
+    production = 2
+
+
+logger = logging.getLogger("qpay")
+
+
+QPAY_USERNAME = os.getenv("QPAY_USERNAME", "TEST_MERCHANT")
+QPAY_PASSWORD = os.getenv("QPAY_PASSWORD", "123456")
+QPAY_ENV = os.getenv("QPAY_ENV", "sandbox")
+
+if QPAY_ENV == "production":
+    is_sandbox = False
+elif QPAY_ENV == "sandbox":
+    is_sandbox = True
+else:
+    raise ValueError("QPAY_ENV must either sandbox or production")
+
+
+# Env based settings
+if is_sandbox:
+    BASE_URL = "https://merchant-sandbox.qpay.mn/v2"
+else:
+    BASE_URL = "https://merchant.qpay.mn/v2"
+
+is_prod = not is_sandbox
+
+
+class QPayClient:
+    """
+    Async QPay v2 client
+    """
+
+    def __init__(
+        self,
+        *,
+        username: Optional[str] = None,
+        password: Optional[str] = None,
+        base_url: Optional[str] = None,
+        is_sandbox: Optional[bool] = None,
+        token_leeway=60,
+        timeout=30,
+        logger=logger,
+    ):
+        if is_sandbox is None:
+            is_sandbox = not is_prod
+
+        if is_sandbox:
+            self._env = Environment.sandbox
+        elif not is_sandbox:
+            self._env = Environment.production
+
+        self._base_url = base_url or BASE_URL
+        self._client = AsyncClient(timeout=timeout)
+        self._auth_credentials = BasicAuth(
+            username=username or QPAY_USERNAME,
+            password=password or QPAY_PASSWORD,
+        )
+        self._access_token = ""
+        self._access_token_expiry = 0
+        self._refresh_token = ""
+        self._refresh_token_expiry = 0
+        self._scope = ""
+        self._not_before_policy = ""
+        self._session_state = ""
+        self._timeout = timeout or 30
+        self._token_leeway = token_leeway or 60
+        self._logger = logger
+
+    @property
+    async def headers(self):
+        token = await self.get_token()
+        return {
+            "Content-Type": "APP_JSON",
+            "Authorization": f"Bearer {token}",
+        }
+
+    def _check_error(self, response: Response):
+        if response.is_error:
+            print(response.json())
+            error_data = response.json()
+            raise QPayError(
+                status_code=response.status_code, error_key=error_data["message"]
+            )
+
+    # Auth
+    async def authenticate(self):
+        response = await self._client.post(
+            BASE_URL + "/auth/token",
+            auth=self._auth_credentials,
+            timeout=self._timeout,
+        )
+        # Raises status error if there is error
+        self._check_error(response)
+
+        data = TokenResponse.model_validate(response.json())
+
+        self._access_token = data.access_token
+        self._refresh_token = data.refresh_token
+        self._access_token_expiry = data.expires_in - self._token_leeway
+        self._refresh_token_expiry = data.refresh_expires_in - self._token_leeway
+        self._scope = data.scope
+        self._not_before_policy = data.not_before_policy
+        self._session_state = data.session_state
+
+    async def refresh_access_token(self):
+        if not self._refresh_token or time.time() >= self._refresh_token_expiry:
+            await self.authenticate()
+            return
+
+        response = await self._client.post(
+            BASE_URL + "/auth/refresh",
+            headers={"Authorization": f"Bearer {self._refresh_token}"},
+            timeout=self._timeout,
+        )
+
+        self._check_error(response)
+
+        if response.is_success:
+            data = TokenResponse.model_validate(response.json())
+
+            self._access_token = data.access_token
+            self._refresh_token = data.refresh_token
+            self._access_token_expiry = data.expires_in - self._token_leeway
+            self._refresh_token_expiry = data.refresh_expires_in - self._token_leeway
+        else:
+            await self.authenticate()
+
+    async def get_token(self):
+        if not self._access_token:
+            await self.authenticate()
+        elif time.time() >= self._access_token_expiry:
+            await self.refresh_access_token()
+        return self._access_token
+
+    # Invoice
+    async def invoice_create(
+        self, create_invoice_request: InvoiceCreateRequest | InvoiceCreateSimpleRequest
+    ):
+        response = await self._client.post(
+            BASE_URL + "/invoice",
+            headers=await self.headers,
+            data=create_invoice_request.model_dump(),
+            timeout=self._timeout,
+        )
+
+        self._check_error(response)
+
+        data = CreateInvoiceResponse.model_validate_json(response.json())
+        return data
+
+    async def invoice_cancel(
+        self,
+        invoice_id: str,
+    ):
+        response = await self._client.delete(
+            BASE_URL + "/invoice/" + invoice_id,
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+        
+        return response.json()
+
+    # Payment
+    async def payment_get(self, payment_id: str):
+        response = await self._client.get(
+            BASE_URL + "/payment/" + payment_id,
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+        
+        validated_response = Payment.model_validate(response.json())
+        return validated_response
+
+    async def payment_check(self, payment_check_request: PaymentCheckRequest):
+        response = await self._client.post(
+            BASE_URL + "/payment/check",
+            data=payment_check_request.model_dump(),
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+
+        validated_response = PaymentCheckResponse.model_validate_json(response.json())
+        return validated_response
+
+    async def payment_cancel(self, payment_id: str):
+        response = await self._client.delete(
+            BASE_URL + "/payment/cancel/" + payment_id,
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+        
+        return response.json()
+
+    async def payment_refund(self, payment_id: str):
+        response = await self._client.delete(
+            BASE_URL + "/payment/refund/" + payment_id,
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+        
+        return response.json()
+
+    async def payment_list(self, payment_list_request: PaymentListRequest):
+        response = await self._client.post(
+            BASE_URL + "/payment/list",
+            data=payment_list_request.model_dump(),
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+
+        validated_response = PaymentCheckResponse.model_validate_json(response.json())
+        return validated_response
+
+    # ebarimt
+    async def ebarimt_create(self, ebarimt_create_request: EbarimtCreateRequest):
+        response = await self._client.post(
+            BASE_URL + "/ebarimt/create",
+            data=ebarimt_create_request.model_dump(),
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+
+        validated_response = Ebarimt.model_validate_json(response.json())
+        return validated_response
+
+    async def ebarimt_get(self, barimt_id: str):
+        response = await self._client.get(
+            BASE_URL + "/ebarimt/" + barimt_id,
+            headers=await self.headers,
+            timeout=self._timeout,
+        )
+        
+        self._check_error(response)
+
+        validated_response = Ebarimt.model_validate_json(response.json())
+        return validated_response

qpay_client-0.1.0/src/qpay_client/v2/schemas.py

@@ -0,0 +1,306 @@
+from typing import Optional, Dict, List
+from pydantic import BaseModel, Field, ConfigDict
+from datetime import date, datetime
+from decimal import Decimal
+from enum import StrEnum
+
+
+class Currency(StrEnum):
+    mnt = "MNT"
+    usd = "USD"
+    cny = "CNY"
+    jpy = "JPY"
+    rub = "RUB"
+    eur = "EUR"
+
+
+class PaymentStatus(StrEnum):
+    new = "NEW"
+    failed = "FAILED"
+    paid = "PAID"
+    partial = "PARTIAL"
+    refunded = "REFUNDED"
+
+
+class BankCode(StrEnum):
+    bank_of_mongolia = "010000"
+    capital_bank = "020000"
+    trade_and_development_bank_of_mongolia = "040000"
+    khan_bank = "050000"
+    golomt_bank = "150000"
+    trans_bank = "190000"
+    arig_bank = "210000"
+    credit_bank = "220000"
+    nib_bank = "290000"
+    capitron_bank = "300000"
+    khas_bank = "320000"
+    chingiskhan_bank = "330000"
+    state_bank = "340000"
+    national_development_bank = "360000"
+    bogd_bank = "380000"
+    state_fund = "900000"
+    mobi_finance = "500000"
+    m_bank = "390000"
+    invescore = "993000"
+    test_bank = "100000"
+
+
+class ObjectTypeNum(StrEnum):
+    invoice = "INVOICE"
+    qr = "QR"
+    item = "ITEM"
+
+
+class TokenResponse(BaseModel):
+    token_type: str
+    access_token: str
+    expires_in: float
+    refresh_token: str
+    refresh_expires_in: float
+    scope: str
+    not_before_policy: str = Field(..., alias="not-before-policy")
+    session_state: str
+
+
+class QPayDeeplink(BaseModel):
+    name: str
+    description: str
+    logo: str
+    link: str
+
+
+class Address(BaseModel):
+    city: Optional[str] = Field(default=None, max_length=100)
+    district: Optional[str] = Field(default=None, max_length=100)
+    street: Optional[str] = Field(default=None, max_length=100)
+    building: Optional[str] = Field(default=None, max_length=100)
+    address: Optional[str] = Field(default=None, max_length=100)
+    zipcode: Optional[str] = Field(default=None, max_length=20)
+    longitude: Optional[str] = Field(default=None, max_length=20)
+    latitude: Optional[str] = Field(default=None, max_length=20)
+
+
+class SenderTerminalData(BaseModel):
+    name: Optional[str] = Field(default=None, max_length=100)
+
+
+class InvoiceReceiverData(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    registration_number: Optional[str] = Field(
+        default=None, alias="register", max_length=20
+    )
+    name: Optional[str] = Field(default=None, max_length=100)
+    email: Optional[str] = Field(default=None, max_length=255)
+    phone: Optional[str] = Field(default=None, max_length=20)
+    address: Optional[Address] = None
+
+
+class SenderBranchData(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    registration_number: Optional[str] = Field(
+        default=None, alias="register", max_length=20
+    )
+    name: Optional[str] = Field(default=None, max_length=100)
+    email: Optional[str] = Field(default=None, max_length=255)
+    phone: Optional[str] = Field(default=None, max_length=20)
+    address: Optional[Address] = None
+
+
+class Discount(BaseModel):
+    discount_code: Optional[str] = Field(default=None, max_length=45)
+    description: str = Field(max_length=100)
+    amount: Decimal = Field(max_digits=20)
+    note: Optional[str] = Field(default=None, max_length=255)
+
+
+class Surcharge(BaseModel):
+    surcharge_code: Optional[str] = Field(default=None, max_length=45)
+    description: str = Field(max_length=100)
+    amount: Decimal = Field(max_digits=20)
+    note: Optional[str] = Field(default=None, max_length=255)
+
+
+class Tax(BaseModel):
+    tax_code: Optional[str] = Field(default=None, max_length=20)
+    description: Optional[str] = Field(default=None, max_length=100)
+    amount: Decimal
+    note: Optional[str] = Field(default=None, max_length=255)
+
+
+class Line(BaseModel):
+    sender_product_code: Optional[str]
+    tax_product_code: Optional[str]
+    line_description: str = Field(max_length=255)
+    line_quantity: Decimal = Field(max_digits=20)
+    line_unit_price: Decimal = Field(max_digits=20)
+    note: Optional[str] = Field(default=None, max_length=100)
+    discounts: Optional[List[Discount]] = None
+    surcharges: Optional[List[Surcharge]] = None
+    taxes: Optional[List[Tax]] = None
+
+
+class SenderStaffData(BaseModel):
+    name: Optional[str] = Field(default=None, max_length=100)
+    email: Optional[str] = Field(default=None, max_length=255)
+    phone: Optional[str] = Field(default=None, max_length=20)
+
+
+class InvoiceCreateSimpleRequest(BaseModel):
+    invoice_code: str = Field(examples=["TEST_INVOICE"], max_length=45)
+    sender_invoice_no: str = Field(examples=["123"], max_length=45)
+    invoice_receiver_code: str = Field(max_length=45)
+    invoice_description: str = Field(max_length=255)
+    sender_branch_code: Optional[str] = Field(default=None, max_length=45)
+    amount: Decimal = Field(gt=0)
+    callback_url: str = Field(max_length=255)
+
+
+class InvoiceCreateRequest(BaseModel):
+    invoice_code: str = Field(max_length=45)
+    sender_invoice_no: str = Field(max_length=45)
+    sender_branch_code: Optional[str] = Field(default=None, max_length=45)
+    sender_branch_data: Optional[SenderBranchData] = None
+    sender_staff_code: Optional[str] = Field(default=None, max_length=100)
+    sender_staff_data: Optional[SenderStaffData] = None
+    sender_terminal_code: Optional[str] = Field(default=None, max_length=45)
+    sender_terminal_data: Optional[SenderTerminalData] = None
+    invoice_receiver_code: str = Field(max_length=45)
+    invoice_receiver_data: Optional[InvoiceReceiverData] = None
+    invoice_description: str = Field(max_length=255)
+    invoice_due_date: Optional[date] = None
+    enable_expiry: Optional[bool] = None
+    expiry_date: Optional[date] = None
+    calculate_vat: Optional[bool] = Field(default=None)
+    tax_customer_code: Optional[str] = None
+    line_tax_code: Optional[str] = Field(default=None)
+    allow_partial: Optional[bool] = Field(default=None)
+    minimum_amount: Optional[Decimal] = None
+    allow_exceed: Optional[bool] = Field(default=None)
+    maximum_amount: Optional[Decimal] = None
+    amount: Optional[Decimal] = Field(default=None)
+    callback_url: str = Field(max_length=255)
+    note: Optional[str] = Field(default=None, max_length=1000)
+    lines: Optional[List[Line]] = None
+    transactions: Optional[List] = None
+
+
+class CreateInvoiceResponse(BaseModel):
+    invoice_id: str
+    qr_text: str
+    qr_image: str
+    qPay_shortUrl: str
+    urls: List[QPayDeeplink]
+
+
+class CardTransaction(BaseModel):
+    card_type: str
+    is_cross_border: bool
+    amount: Decimal
+    currency: Currency
+    date: datetime
+    status: str
+    settlement_status: str
+    settlement_status_date: datetime
+
+
+class P2PTransaction(BaseModel):
+    transaction_bank_code: BankCode
+    account_bank_code: BankCode
+    account_bank_name: str
+    account_number: str
+    status: str
+    amount: Decimal
+    currency: Currency
+    settlement_status: str
+
+
+class Payment(BaseModel):
+    payment_id: Decimal
+    payment_status: PaymentStatus
+    payment_amount: Decimal
+    trx_fee: Decimal
+    payment_currency: Currency
+    payment_wallet: str
+    payment_type: str
+    next_payment_date: Optional[date] = None
+    next_payment_datetime: Optional[datetime] = None
+    card_transactions: List[CardTransaction]
+    p2p_transactions: List[P2PTransaction]
+
+
+class Offset(BaseModel):
+    page_number: Decimal = Field(default=Decimal(1), ge=1, le=100)
+    page_limit: Decimal = Field(default=Decimal(10), ge=1, le=100)
+
+
+class PaymentCheckResponse(BaseModel):
+    count: Optional[Decimal] = None
+    paid_amount: Optional[Decimal] = None
+    rows: Optional[List[Payment]] = None
+
+
+class PaymentCheckRequest(BaseModel):
+    object_type: ObjectTypeNum
+    object_id: str = Field(max_length=50)
+    offset: Optional[Offset] = Field(default_factory=Offset)
+
+
+class CancelPaymentRequest(Payment):
+    callback_url: str
+    note: str
+
+
+class EbarimtCreateRequest(BaseModel):
+    payment_id: str
+    ebarimt_receiver_type: str
+    ebarimt_receiver: Optional[str] = None
+    callback_url: Optional[str] = None
+
+
+class Ebarimt(BaseModel):
+    id: str
+    ebarimt_by: str
+    g_wallet_id: str
+    g_wallet_customer_id: str
+    ebarim_receiver_type: str
+    ebarimt_receiver: str
+    ebarimt_district_code: str
+    ebarimt_bill_type: str
+    g_merchant_id: str
+    merchant_branch_code: str
+    merchant_terminal_code: str
+    merchant_staff_code: str
+    merchant_register: Decimal
+    g_payment_id: Decimal
+    paid_by: str
+    object_type: str
+    object_id: str
+    amount: Decimal
+    vat_amount: Decimal
+    city_tax_amount: Decimal
+    ebarimt_qr_data: str
+    ebarimt_lottery: str
+    note: str
+    ebarimt_status: str
+    ebarimt_status_date: datetime
+    tax_type: str
+    created_by: str
+    created_date: datetime
+    updated_by: str
+    updated_date: datetime
+    status: bool
+
+
+class PaymentListRequest(BaseModel):
+    object_type: str
+    object_id: str
+    start_date: datetime
+    end_date: datetime
+    offset: Offset
+
+
+class PaymentCancelRequest(BaseModel):
+    callback_url: Optional[str] = None
+    note: Optional[str] = None