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

kard/transactions/types/fraudulent_transaction_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 .fraudulent_transaction_data import FraudulentTransactionData
+
+
+class FraudulentTransactionResponse(ErrorResponse):
+    data: typing.List[FraudulentTransactionData]
+
+    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/get_earned_rewards_response.py

@@ -0,0 +1,133 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.links import Links
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .rewarded_transaction_union import RewardedTransactionUnion
+from .transaction_included_resource import TransactionIncludedResource
+
+
+class GetEarnedRewardsResponse(UniversalBaseModel):
+    """
+    Examples
+    --------
+    import datetime
+
+    from kard.commons import (
+        CommissionValue,
+        Links,
+        RelationshipData,
+        RelationshipSingle,
+    )
+    from kard.transactions import (
+        CommissionEarnedDetails,
+        GetEarnedRewardsResponse,
+        RewardedTransactionAttributes,
+        RewardedTransactionRelationships,
+        RewardedTransactionUnion_RewardedTransaction,
+        TransactionIncludedResource_Merchant,
+        TransactionIncludedResource_Offer,
+        TransactionMerchantAttributes,
+        TransactionOfferAttributes,
+    )
+
+    GetEarnedRewardsResponse(
+        data=[
+            RewardedTransactionUnion_RewardedTransaction(
+                id="fcabf024-3870-41f3-9fbd-b43ea85a3d19",
+                attributes=RewardedTransactionAttributes(
+                    status="SETTLED",
+                    transaction_id="TXN-20241001-F21-127964",
+                    transaction_amount_in_cents=12796,
+                    transaction_timestamp=datetime.datetime.fromisoformat(
+                        "2024-10-01 01:36:57+00:00",
+                    ),
+                    paid_to_issuer="UNPAID",
+                    payout_timestamp=datetime.datetime.fromisoformat(
+                        "2024-10-01 02:00:00+00:00",
+                    ),
+                    card_bin="123456",
+                    card_last_four="4321",
+                    commission_earned=CommissionEarnedDetails(
+                        issuer=CommissionValue(
+                            type="cents",
+                            value=102,
+                        ),
+                        user=CommissionValue(
+                            type="cents",
+                            value=320,
+                        ),
+                    ),
+                ),
+                relationships=RewardedTransactionRelationships(
+                    user=RelationshipSingle(
+                        data=RelationshipData(
+                            type="user",
+                            id="8c52423a-c319-44ee-8fc7-508e97b43892",
+                        ),
+                    ),
+                    merchant=RelationshipSingle(
+                        data=RelationshipData(
+                            type="merchant",
+                            id="633ed2ab30dcb60009dd5699",
+                        ),
+                    ),
+                    offer=RelationshipSingle(
+                        data=RelationshipData(
+                            type="offer",
+                            id="OFF-F21-INSTORE-2024Q4-001",
+                        ),
+                    ),
+                ),
+            )
+        ],
+        links=Links(
+            self_="/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10",
+            next="/v2/issuers/org-123/users/user-456/earned-rewards?page[size]=10&page[after]=eyJpZCI6ImZjYWJmMDI0LTM4NzAtNDFmMy05ZmJkLWI0M2VhODVhM2QxOSIsInRzIjoiMjAyNC0xMC0wMVQwMTozNjo1N1oifQ==",
+        ),
+        included=[
+            TransactionIncludedResource_Merchant(
+                id="633ed2ab30dcb60009dd5699",
+                attributes=TransactionMerchantAttributes(
+                    name="Forever 21",
+                ),
+            ),
+            TransactionIncludedResource_Merchant(
+                id="5f3e2d1c40abc50008cc4821",
+                attributes=TransactionMerchantAttributes(
+                    name="Target",
+                ),
+            ),
+            TransactionIncludedResource_Offer(
+                id="OFF-F21-INSTORE-2024Q4-001",
+                attributes=TransactionOfferAttributes(
+                    purchase_channel=["INSTORE"],
+                ),
+            ),
+            TransactionIncludedResource_Offer(
+                id="OFF-TGT-ONLINE-2024Q4-002",
+                attributes=TransactionOfferAttributes(
+                    purchase_channel=["ONLINE"],
+                ),
+            ),
+        ],
+    )
+    """
+
+    data: typing.List[RewardedTransactionUnion]
+    links: Links
+    included: typing.Optional[typing.List[TransactionIncludedResource]] = pydantic.Field(default=None)
+    """
+    Additional resources referenced in the response
+    """
+
+    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/matched_transactions_attributes.py

@@ -0,0 +1,156 @@
+# 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 .payment_type import PaymentType
+from .receipt_medium_type import ReceiptMediumType
+
+
+class MatchedTransactionsAttributes(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).
+    """
+
+    description: str = pydantic.Field()
+    """
+    Description of transaction - usually includes merchant and other key details on transaction
+    """
+
+    authorization_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="authorizationDate")] = (
+        pydantic.Field()
+    )
+    """
+    Timestamp for transaction event. 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`
+    """
+
+    matched_offer_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="matchedOfferId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The ID of the Kard offer to which the transaction was matched. If this field is omitted, the transaction will be considered unmatched to any Kard offer. This field **must** be omitted when the `paymentType` is `UNKNOWN` and neither an orderId nor a `cardLastFour` is supplied.
+    """
+
+    matched_location_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="matchedLocationId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The unique Kard location ID where the transaction took place. This field **must** be omitted  when `paymentType` is `UNKNOWN`.
+    """
+
+    merchant: typing.Optional[Merchant] = pydantic.Field(default=None)
+    """
+    Merchant details
+    """
+
+    payment_type: typing_extensions.Annotated[PaymentType, FieldMetadata(alias="paymentType")] = pydantic.Field()
+    """
+    The type of payment involved in the transaction.
+    """
+
+    card_bin: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardBIN")] = pydantic.Field(
+        default=None
+    )
+    """
+    Bank identification number (BIN). Must be a valid BIN of 6 digits. If over 6 digits, please send first 6. This field **must** be omitted when `paymentType` is `CASH` or `UNKNOWN`.
+    """
+
+    card_last_four: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardLastFour")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Card last four digits. This field is **required** when `paymentType` is `CARD` and `matchedOfferId` is provided. It **must** be omitted when `paymentType` is `CASH`.
+    """
+
+    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
+    """
+
+    card_network: typing_extensions.Annotated[typing.Optional[CardNetwork], FieldMetadata(alias="cardNetwork")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The card network associated with the transaction. This field **must** be omitted when `paymentType` is `CASH` or `UNKNOWN`.
+    """
+
+    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. This field **must** be omitted when `paymentType` is `CASH` or `UNKNOWN`.
+    """
+
+    order_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="orderId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The unique identifier for an online order linked to this transaction.
+    """
+
+    receipt_medium: typing_extensions.Annotated[
+        typing.Optional[ReceiptMediumType], FieldMetadata(alias="receiptMedium")
+    ] = pydantic.Field(default=None)
+    """
+    Indicates the format of the receipt from which the transaction is derived.
+    """
+
+    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/matched_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 .matched_transactions_attributes import MatchedTransactionsAttributes
+
+
+class MatchedTransactionsRequest(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: 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

kard/transactions/types/merchant.py

@@ -0,0 +1,82 @@
+# 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
+from .states import States
+
+
+class Merchant(UniversalBaseModel):
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Acquirer Merchant Identification Number (MID) — usually a 15 digit numerical identifier code. <b>Note, this field is REQUIRED for local offers. We HIGHLY RECOMMEND sending this field as it will be required in the near future.</b>
+    """
+
+    name: str = pydantic.Field()
+    """
+    Merchant name associated with transaction
+    """
+
+    addr_street: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="addrStreet")] = pydantic.Field(
+        default=None
+    )
+    """
+    Merchant street address associated with transaction.
+    """
+
+    addr_city: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="addrCity")] = pydantic.Field(
+        default=None
+    )
+    """
+    Merchant address city associated with transaction.
+    """
+
+    addr_state: typing_extensions.Annotated[typing.Optional[States], FieldMetadata(alias="addrState")] = pydantic.Field(
+        default=None
+    )
+    """
+    Merchant address state associated with transaction.
+    """
+
+    addr_zipcode: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="addrZipcode")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Merchant address zip code associated with transaction.
+    """
+
+    addr_country: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="addrCountry")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Merchant address country associated with transaction.
+    """
+
+    latitude: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant latitude geocoordinate associated with transaction.
+    """
+
+    longitude: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant longitude geocoordinate associated with transaction.
+    """
+
+    store_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="storeId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Merchant store ID where transaction originated from
+    """
+
+    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/payment_status.py

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

kard/transactions/types/payment_type.py

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

kard/transactions/types/processor_mid.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .visa_mid_details import VisaMidDetails
+
+
+class ProcessorMid_Visa(UniversalBaseModel):
+    processor: typing.Literal["VISA"] = "VISA"
+    mids: VisaMidDetails
+
+    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
+
+
+ProcessorMid = ProcessorMid_Visa

kard/transactions/types/receipt_medium_type.py

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

kard/transactions/types/rewarded_transaction.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
+from .rewarded_transaction_attributes import RewardedTransactionAttributes
+from .rewarded_transaction_relationships import RewardedTransactionRelationships
+
+
+class RewardedTransaction(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    Unique transaction identifier
+    """
+
+    attributes: RewardedTransactionAttributes
+    relationships: RewardedTransactionRelationships
+
+    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/rewarded_transaction_attributes.py

@@ -0,0 +1,74 @@
+# 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 .commission_earned_details import CommissionEarnedDetails
+from .payment_status import PaymentStatus
+from .rewarded_transaction_status import RewardedTransactionStatus
+
+
+class RewardedTransactionAttributes(UniversalBaseModel):
+    status: RewardedTransactionStatus = pydantic.Field()
+    """
+    Status of the rewarded transaction
+    """
+
+    transaction_id: typing_extensions.Annotated[str, FieldMetadata(alias="transactionId")] = pydantic.Field()
+    """
+    The transaction identifier
+    """
+
+    transaction_amount_in_cents: typing_extensions.Annotated[int, FieldMetadata(alias="transactionAmountInCents")] = (
+        pydantic.Field()
+    )
+    """
+    Transaction amount in cents
+    """
+
+    transaction_timestamp: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="transactionTimestamp")] = (
+        pydantic.Field()
+    )
+    """
+    Timestamp of the transaction in ISO 8601 format
+    """
+
+    paid_to_issuer: typing_extensions.Annotated[PaymentStatus, FieldMetadata(alias="paidToIssuer")] = pydantic.Field()
+    """
+    Payment status to issuer
+    """
+
+    commission_earned: typing_extensions.Annotated[CommissionEarnedDetails, FieldMetadata(alias="commissionEarned")]
+    payout_timestamp: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="payoutTimestamp")
+    ] = pydantic.Field(default=None)
+    """
+    Timestamp representing the month when the transaction has been paid out to issuer
+    """
+
+    card_bin: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardBIN")] = pydantic.Field(
+        default=None
+    )
+    """
+    Bank identification number (BIN).
+    """
+
+    card_last_four: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardLastFour")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Card last four digits.
+    """
+
+    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/rewarded_transaction_relationships.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.relationship_single import RelationshipSingle
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class RewardedTransactionRelationships(UniversalBaseModel):
+    user: RelationshipSingle
+    merchant: RelationshipSingle
+    offer: RelationshipSingle
+
+    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/rewarded_transaction_status.py

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

kard/transactions/types/rewarded_transaction_union.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .rewarded_transaction_attributes import RewardedTransactionAttributes
+from .rewarded_transaction_relationships import RewardedTransactionRelationships
+
+
+class RewardedTransactionUnion_RewardedTransaction(UniversalBaseModel):
+    type: typing.Literal["rewardedTransaction"] = "rewardedTransaction"
+    id: str
+    attributes: RewardedTransactionAttributes
+    relationships: RewardedTransactionRelationships
+
+    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
+
+
+RewardedTransactionUnion = RewardedTransactionUnion_RewardedTransaction