pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/settlement_by_utr_response.py

@@ -0,0 +1,146 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .settlement_by_utr_response_pagination import SettlementByUtrResponsePagination
+from .settlement_transaction import SettlementTransaction
+
+
+class SettlementByUtrResponse(UniversalBaseModel):
+    """
+    Response from the Get Settlements by UTR API.
+    """
+
+    utr_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique Transaction Reference provided by the bank.
+    """
+
+    bank_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Settlement bank name.
+    """
+
+    bank_acc_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Settlement bank account number.
+    """
+
+    programs: typing.Optional[typing.List[str]] = None
+    total_transaction_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of transactions in this UTR.
+    """
+
+    total_transaction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total transaction amount settled after deductions.
+    """
+
+    actual_transaction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total transaction amount without deductions.
+    """
+
+    total_refund: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total refund amount deducted.
+    """
+
+    total_chargeback_recovery_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total chargeback recovery amount.
+    """
+
+    total_loan_recovery_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total loan recovery amount.
+    """
+
+    total_mdr_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total MDR (Merchant Discount Rate) amount.
+    """
+
+    total_gst_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total GST amount charged.
+    """
+
+    total_late_settlement_fee: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total late settlement fee.
+    """
+
+    total_settled_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total settled amount.
+    """
+
+    total_mar_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total Merchant Acquisition Rate charged.
+    """
+
+    split_fund_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Split amount of the transaction.
+    """
+
+    total_platform_fee: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total platform fee charged.
+    """
+
+    other_deductions: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Other deductions.
+    """
+
+    additional_mdr_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Additional MDR amount deducted.
+    """
+
+    total_convenience_fee: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total convenience fee charged.
+    """
+
+    total_gst_on_c_c_f: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    GST charged on convenience fees.
+    """
+
+    total_cashback_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total cashback amount provided.
+    """
+
+    total_merchant_cashback: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total merchant cashback amount.
+    """
+
+    total_merchant_convenience_fee: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total merchant convenience fee.
+    """
+
+    transactions: typing.Optional[typing.List[SettlementTransaction]] = pydantic.Field(default=None)
+    """
+    Array of individual transaction details.
+    """
+
+    pagination: typing.Optional[SettlementByUtrResponsePagination] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/settlement_by_utr_response_pagination.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SettlementByUtrResponsePagination(UniversalBaseModel):
+    total_pages: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of pages.
+    """
+
+    current_page: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Current page number.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/settlement_summary.py

@@ -0,0 +1,76 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SettlementSummary(UniversalBaseModel):
+    """
+    Individual settlement summary record.
+    """
+
+    total_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total settlement amount.
+    """
+
+    actual_transaction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total transaction amount without deductions.
+    """
+
+    total_deduction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total deduction amount.
+    """
+
+    total_transactions_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of transactions settled within this UTR.
+    """
+
+    last_processed_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date when transactions were last processed for settlement.
+    """
+
+    settled_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date on which the batch was settled.
+    """
+
+    utr_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique Transaction Reference generated for the settlement.
+    """
+
+    programs: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Payment programs included in this settlement.
+    """
+
+    system: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Constant system identifier.
+    """
+
+    bank_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Settlement bank name.
+    """
+
+    bank_acc_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Settlement bank account number.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/settlement_transaction.py

@@ -0,0 +1,96 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SettlementTransaction(UniversalBaseModel):
+    """
+    Individual transaction within a UTR settlement.
+    """
+
+    transaction_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the transaction.
+    """
+
+    system: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Constant system identifier.
+    """
+
+    processed_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date when the transaction was processed.
+    """
+
+    transaction_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date of the transaction.
+    """
+
+    transaction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Transaction amount.
+    """
+
+    actual_transaction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total transaction amount without deductions.
+    """
+
+    total_deduction_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total deduction amount.
+    """
+
+    settled_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Settled amount for this transaction.
+    """
+
+    store_address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Address of the store (applicable for POS transactions).
+    """
+
+    acquirer_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the acquirer.
+    """
+
+    tid: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Terminal ID for the transaction.
+    """
+
+    is_emi: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the transaction was an EMI.
+    """
+
+    utr_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    UTR number.
+    """
+
+    program: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Payment method used.
+    """
+
+    payout_status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status of the payout.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/simple_amount.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SimpleAmount(UniversalBaseModel):
+    """
+    Monetary amount with currency (no min/max constraints). Used for fees, tax, and balance values.
+    """
+
+    value: int = pydantic.Field()
+    """
+    Amount in the smallest currency unit (paisa for INR).
+    """
+
+    currency: str = pydantic.Field()
+    """
+    Three-letter ISO 4217 currency code.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_detail.py

@@ -0,0 +1,55 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .amount import Amount
+from .split_detail_status import SplitDetailStatus
+
+
+class SplitDetail(UniversalBaseModel):
+    """
+    Individual split settlement detail.
+    """
+
+    split_merchant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the partner merchant.
+    """
+
+    split_settlement_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the split settlement.
+    """
+
+    merchant_settlement_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier entered while creating an order in split.
+    """
+
+    amount: typing.Optional[Amount] = None
+    on_hold: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the settlement is on hold for future release.
+    """
+
+    status: typing.Optional[SplitDetailStatus] = pydantic.Field(default=None)
+    """
+    Split settlement status.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the split order was created.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_detail_refund.py

@@ -0,0 +1,51 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .split_detail_refund_amount import SplitDetailRefundAmount
+from .split_detail_refund_status import SplitDetailRefundStatus
+
+
+class SplitDetailRefund(UniversalBaseModel):
+    parent_order_split_settlement_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the parent split settlement.
+    """
+
+    split_merchant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the partner merchant.
+    """
+
+    split_settlement_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the refund split settlement.
+    """
+
+    merchant_settlement_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant settlement reference.
+    """
+
+    amount: typing.Optional[SplitDetailRefundAmount] = None
+    status: typing.Optional[SplitDetailRefundStatus] = pydantic.Field(default=None)
+    """
+    Split settlement recovery status.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the split was created.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_detail_refund_amount.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SplitDetailRefundAmount(UniversalBaseModel):
+    value: typing.Optional[int] = None
+    currency: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_detail_refund_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SplitDetailRefundStatus = typing.Union[typing.Literal["DO_NOT_RECOVER", ""], typing.Any]

pinelabs/types/split_detail_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SplitDetailStatus = typing.Union[typing.Literal["RELEASED", "HOLD"], typing.Any]

pinelabs/types/split_info.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .split_detail import SplitDetail
+
+
+class SplitInfo(UniversalBaseModel):
+    """
+    Split settlement information for marketplace flows.
+    """
+
+    split_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Type of split.
+    """
+
+    split_details: typing.Optional[typing.List[SplitDetail]] = pydantic.Field(default=None)
+    """
+    Array of split details.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_payment_object.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .split_payment_object_acquirer_data import SplitPaymentObjectAcquirerData
+from .split_payment_object_additional_detail import SplitPaymentObjectAdditionalDetail
+from .split_payment_object_capture_data_item import SplitPaymentObjectCaptureDataItem
+from .split_payment_object_payment_amount import SplitPaymentObjectPaymentAmount
+from .split_payment_object_payment_method import SplitPaymentObjectPaymentMethod
+from .split_payment_object_payment_option import SplitPaymentObjectPaymentOption
+from .split_payment_object_status import SplitPaymentObjectStatus
+
+
+class SplitPaymentObject(UniversalBaseModel):
+    """
+    Payment details in a split settlement response.
+    """
+
+    id: typing.Optional[str] = None
+    merchant_payment_reference: typing.Optional[str] = None
+    status: typing.Optional[SplitPaymentObjectStatus] = None
+    payment_amount: typing.Optional[SplitPaymentObjectPaymentAmount] = None
+    payment_method: typing.Optional[SplitPaymentObjectPaymentMethod] = None
+    payment_option: typing.Optional[SplitPaymentObjectPaymentOption] = None
+    acquirer_data: typing.Optional[SplitPaymentObjectAcquirerData] = None
+    capture_data: typing.Optional[typing.List[SplitPaymentObjectCaptureDataItem]] = pydantic.Field(default=None)
+    """
+    Capture details. Present only for pre-authorized orders.
+    """
+
+    additional_detail: typing.Optional[SplitPaymentObjectAdditionalDetail] = pydantic.Field(default=None)
+    """
+    Additional details related to the payment.
+    """
+
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_payment_object_acquirer_data.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SplitPaymentObjectAcquirerData(UniversalBaseModel):
+    approval_code: typing.Optional[str] = None
+    acquirer_reference: typing.Optional[str] = None
+    rrn: typing.Optional[str] = None
+    is_aggregator: typing.Optional[bool] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_payment_object_additional_detail.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SplitPaymentObjectAdditionalDetail(UniversalBaseModel):
+    """
+    Additional details related to the payment.
+    """
+
+    source_ip: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    IP address of the merchant.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/split_payment_object_capture_data_item.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .split_payment_object_capture_data_item_capture_amount import SplitPaymentObjectCaptureDataItemCaptureAmount
+
+
+class SplitPaymentObjectCaptureDataItem(UniversalBaseModel):
+    merchant_capture_reference: typing.Optional[str] = None
+    capture_amount: typing.Optional[SplitPaymentObjectCaptureDataItemCaptureAmount] = None
+    created_at: typing.Optional[dt.datetime] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow