kard-financial-sdk 0.0.82__py3-none-any.whl

kard/transactions/types/states.py

@@ -0,0 +1,68 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+States = typing.Union[
+    typing.Literal[
+        "AL",
+        "AK",
+        "AS",
+        "AZ",
+        "AR",
+        "CA",
+        "CO",
+        "CT",
+        "DE",
+        "DC",
+        "FM",
+        "FL",
+        "GA",
+        "GU",
+        "HI",
+        "ID",
+        "IL",
+        "IN",
+        "IA",
+        "KS",
+        "KY",
+        "LA",
+        "ME",
+        "MH",
+        "MD",
+        "MA",
+        "MI",
+        "MN",
+        "MS",
+        "MO",
+        "MT",
+        "NE",
+        "NV",
+        "NH",
+        "NJ",
+        "NM",
+        "NY",
+        "NC",
+        "ND",
+        "MP",
+        "OH",
+        "OK",
+        "OR",
+        "PW",
+        "PA",
+        "PR",
+        "RI",
+        "SC",
+        "SD",
+        "TN",
+        "TX",
+        "UT",
+        "VT",
+        "VI",
+        "VA",
+        "WA",
+        "WV",
+        "WI",
+        "WY",
+    ],
+    typing.Any,
+]

kard/transactions/types/transaction_included_resource.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .transaction_merchant_attributes import TransactionMerchantAttributes
+from .transaction_offer_attributes import TransactionOfferAttributes
+
+
+class TransactionIncludedResource_Merchant(UniversalBaseModel):
+    type: typing.Literal["merchant"] = "merchant"
+    id: str
+    attributes: TransactionMerchantAttributes
+
+    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
+
+
+class TransactionIncludedResource_Offer(UniversalBaseModel):
+    type: typing.Literal["offer"] = "offer"
+    id: str
+    attributes: TransactionOfferAttributes
+
+    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
+
+
+TransactionIncludedResource = typing_extensions.Annotated[
+    typing.Union[TransactionIncludedResource_Merchant, TransactionIncludedResource_Offer],
+    pydantic.Field(discriminator="type"),
+]

kard/transactions/types/transaction_merchant_attributes.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 TransactionMerchantAttributes(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    Merchant name
+    """
+
+    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

kard/transactions/types/transaction_merchant_resource.py

@@ -0,0 +1,28 @@
+# 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 .transaction_merchant_attributes import TransactionMerchantAttributes
+
+
+class TransactionMerchantResource(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    Merchant identifier
+    """
+
+    attributes: TransactionMerchantAttributes = pydantic.Field()
+    """
+    Merchant attributes
+    """
+
+    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

kard/transactions/types/transaction_offer_attributes.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class TransactionOfferAttributes(UniversalBaseModel):
+    purchase_channel: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="purchaseChannel")] = (
+        pydantic.Field()
+    )
+    """
+    Purchase channels
+    """
+
+    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

kard/transactions/types/transaction_offer_resource.py

@@ -0,0 +1,28 @@
+# 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 .transaction_offer_attributes import TransactionOfferAttributes
+
+
+class TransactionOfferResource(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    Offer identifier
+    """
+
+    attributes: TransactionOfferAttributes = pydantic.Field()
+    """
+    Offer attributes
+    """
+
+    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

kard/transactions/types/transaction_payment_type.py

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

kard/transactions/types/transaction_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TransactionStatus = typing.Union[typing.Literal["APPROVED", "SETTLED", "REVERSED", "RETURNED", "DECLINED"], typing.Any]

kard/transactions/types/transactions.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .matched_transactions_attributes import MatchedTransactionsAttributes
+from .transactions_attributes import TransactionsAttributes
+
+
+class Transactions_Transaction(UniversalBaseModel):
+    type: typing.Literal["transaction"] = "transaction"
+    id: str
+    attributes: TransactionsAttributes
+
+    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
+
+
+class Transactions_MatchedTransaction(UniversalBaseModel):
+    type: typing.Literal["matchedTransaction"] = "matchedTransaction"
+    id: str
+    attributes: MatchedTransactionsAttributes
+
+    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
+
+
+Transactions = typing_extensions.Annotated[
+    typing.Union[Transactions_Transaction, Transactions_MatchedTransaction], pydantic.Field(discriminator="type")
+]

kard/transactions/types/transactions_attributes.py

@@ -0,0 +1,198 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+from .card_network import CardNetwork
+from .direction_type import DirectionType
+from .merchant import Merchant
+from .processor_mid import ProcessorMid
+from .transaction_payment_type import TransactionPaymentType
+from .transaction_status import TransactionStatus
+
+
+class TransactionsAttributes(UniversalBaseModel):
+    user_id: typing_extensions.Annotated[str, FieldMetadata(alias="userId")] = pydantic.Field()
+    """
+    The ID of the user as defined on the issuers system
+    """
+
+    amount: int = pydantic.Field()
+    """
+    Transaction amount in cents
+    """
+
+    subtotal: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The base amount in cents excluding additional charges (such as tips, taxes, and other fees).
+    """
+
+    status: TransactionStatus = pydantic.Field()
+    """
+    Transaction status
+    """
+
+    currency: str = pydantic.Field()
+    """
+    Currency of transaction
+    """
+
+    description: str = pydantic.Field()
+    """
+    Description of transaction - usually includes merchant and other key details on transaction
+    """
+
+    description_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="description2")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Description2 of transaction — usually includes other merchant identifying information
+    """
+
+    mcc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant Category Code (usually a 4-digit numerical number). <b>Note, this field is REQUIRED for SOME national offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.</b>
+    """
+
+    core_provider_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="coreProviderId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Name of processor associated with transaction
+    """
+
+    transaction_date: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="transactionDate")
+    ] = pydantic.Field(default=None)
+    """
+    Timestamp for <b>REVERSED, RETURNED, DECLINED</b> transaction events; <b>REQUIRED</b> for transactions with <b>REVERSED, RETURNED, DECLINED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00` OR `1994-11-05T08:15:30Z`
+    """
+
+    authorization_date: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="authorizationDate")
+    ] = pydantic.Field(default=None)
+    """
+    Timestamp for <b>APPROVED</b> transaction event; <b>REQUIRED</b> for transactions with <b>APPROVED</b> status, and <b>HIGHLY RECOMMENDED</b> to include for transactions with a <b>SETTLED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00 OR 1994-11-05T08:15:30Z`
+    """
+
+    settled_date: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="settledDate")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Timestamp for <b>SETTLED</b> transaction event, <b>REQUIRED</b> for transactions with <b>SETTLED</b> status. Date string should be in ISO format i.e.`'YYYY-MM-DDThh:mm:ss.sTZD'` where TZD = time zone designator (Z or +hh:mm or -hh:mm) i.e. `1994-11-05T08:15:30-05:00` OR `1994-11-05T08:15:30Z`
+    """
+
+    merchant: typing.Optional[Merchant] = pydantic.Field(default=None)
+    """
+    Merchant details
+    """
+
+    card_presence: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardPresence")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Whether card was present at time of transaction
+    """
+
+    pan_entry_mode: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="panEntryMode")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    PAN entry mode
+    """
+
+    card_bin: typing_extensions.Annotated[str, FieldMetadata(alias="cardBIN")] = pydantic.Field()
+    """
+    Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6.
+    """
+
+    card_last_four: typing_extensions.Annotated[str, FieldMetadata(alias="cardLastFour")] = pydantic.Field()
+    """
+    Card last four digits.
+    """
+
+    authorization_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="authorizationCode")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Transaction approval code
+    """
+
+    retrieval_reference_number: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="retrievalReferenceNumber")
+    ] = pydantic.Field(default=None)
+    """
+    Retrieval Reference Number
+    """
+
+    system_trace_audit_number: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="systemTraceAuditNumber")
+    ] = pydantic.Field(default=None)
+    """
+    System Trace Audit Number
+    """
+
+    acquirer_reference_number: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="acquirerReferenceNumber")
+    ] = pydantic.Field(default=None)
+    """
+    Acquirer Reference Number
+    """
+
+    direction: DirectionType = pydantic.Field()
+    """
+    The direction in which the funds flow - DEBIT or CREDIT
+    """
+
+    payment_type: typing_extensions.Annotated[TransactionPaymentType, FieldMetadata(alias="paymentType")] = (
+        pydantic.Field()
+    )
+    """
+    The type of payment involved in the transaction.
+    """
+
+    card_network: typing_extensions.Annotated[typing.Optional[CardNetwork], FieldMetadata(alias="cardNetwork")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The card network associated with the transaction
+    """
+
+    transaction_id: typing_extensions.Annotated[str, FieldMetadata(alias="transactionId")] = pydantic.Field()
+    """
+    The transaction ID
+    """
+
+    card_product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardProductId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The card product ID associated with the transaction
+    """
+
+    user_zip_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="userZipCode")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The zip code of the user who made the transaction
+    """
+
+    processor_mids: typing_extensions.Annotated[typing.Optional[ProcessorMid], FieldMetadata(alias="processorMids")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Network specific merchant IDs (MIDs) associated with the transaction
+    """
+
+    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

kard/transactions/types/transactions_multi_response.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.error_response import ErrorResponse
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from .transactions_response_data import TransactionsResponseData
+
+
+class TransactionsMultiResponse(ErrorResponse):
+    data: TransactionsResponseData
+
+    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

kard/transactions/types/transactions_request.py

@@ -0,0 +1,25 @@
+# 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 .transactions_attributes import TransactionsAttributes
+
+
+class TransactionsRequest(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    Unique identifier for the transaction event. This <b>must</b> be unique for each distinct event sent to the API.
+    """
+
+    attributes: TransactionsAttributes
+
+    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

kard/transactions/types/transactions_request_body.py

@@ -0,0 +1,90 @@
+# 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 .transactions import Transactions
+
+
+class TransactionsRequestBody(UniversalBaseModel):
+    """
+    Examples
+    --------
+    import datetime
+
+    from kard.transactions import (
+        Merchant,
+        ProcessorMid_Visa,
+        Transactions_Transaction,
+        TransactionsAttributes,
+        TransactionsRequestBody,
+        VisaMidDetails,
+    )
+
+    TransactionsRequestBody(
+        data=[
+            Transactions_Transaction(
+                id="309rjfoincor3icno3rind093cdow3jciwjdwcm",
+                attributes=TransactionsAttributes(
+                    user_id="6FHt5b6Fnp0qdomMEy5AN6PXcSJIeX69",
+                    status="APPROVED",
+                    amount=1000,
+                    subtotal=800,
+                    currency="USD",
+                    direction="DEBIT",
+                    payment_type="CARD",
+                    description="ADVANCEAUTO",
+                    description_2="ADVANCEAUTO",
+                    mcc="1234",
+                    card_bin="123456",
+                    card_last_four="4321",
+                    authorization_date=datetime.datetime.fromisoformat(
+                        "2021-07-02 17:47:06+00:00",
+                    ),
+                    merchant=Merchant(
+                        id="12345678901234567",
+                        name="ADVANCEAUTO",
+                        addr_street="125 Main St",
+                        addr_city="Philadelphia",
+                        addr_state="PA",
+                        addr_zipcode="19147",
+                        addr_country="United States",
+                        latitude="37.9419429",
+                        longitude="-73.1446869",
+                        store_id="12345",
+                    ),
+                    authorization_code="123456",
+                    retrieval_reference_number="100804333919",
+                    acquirer_reference_number="1234567890123456789012345678",
+                    system_trace_audit_number="333828",
+                    transaction_id="2467de37-cbdc-416d-a359-75de87bfffb0",
+                    card_product_id="1234567890123456789012345678",
+                    processor_mids=ProcessorMid_Visa(
+                        mids=VisaMidDetails(
+                            vmid="12345678901",
+                            vsid="12345678",
+                        ),
+                    ),
+                ),
+            )
+        ],
+    )
+    """
+
+    data: typing.List[Transactions] = pydantic.Field()
+    """
+    Discriminated union representing the request body for submitting a transaction.
+    Use `type` to distinguish between the two:
+    - `transaction`: For transactions requiring processing and matching by the Kard system.
+    - `matchedTransaction`: For pre-matched transactions that need validation on match by the Kard system.
+    """
+
+    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

kard/transactions/types/transactions_response.py

@@ -0,0 +1,38 @@
+# 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 .transactions_response_data import TransactionsResponseData
+
+
+class TransactionsResponse(UniversalBaseModel):
+    """
+    Examples
+    --------
+    from kard.commons import Job
+    from kard.transactions import TransactionsResponse, TransactionsResponseData
+
+    TransactionsResponse(
+        data=TransactionsResponseData(
+            type="job",
+            id="c94a93a7-beb9-4e58-960c-2c812f849398",
+            attributes=Job(
+                status="queued",
+                message="Incoming Transactions event successfully queued for processing",
+            ),
+        ),
+    )
+    """
+
+    data: TransactionsResponseData
+
+    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

kard/transactions/types/transactions_response_data.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.job import Job
+from ...commons.types.resource_type import ResourceType
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class TransactionsResponseData(UniversalBaseModel):
+    type: ResourceType
+    id: str = pydantic.Field()
+    """
+    The request id of the pending job
+    """
+
+    attributes: Job
+
+    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