Entities

AccountTransferId module-attribute

AccountTransferId = NewType('AccountTransferId', UUID)

BankTransferId module-attribute

BankTransferId = NewType('BankTransferId', UUID)

CardTransferId module-attribute

CardTransferId = NewType('CardTransferId', UUID)

InternalTransferId module-attribute

InternalTransferId = NewType('InternalTransferId', UUID)

Transfer module-attribute

Transfer = (
    CardTransfer
    | BankTransfer
    | AccountTransfer
    | InternalTransfer
)

TransferEventId module-attribute

TransferEventId = NewType('TransferEventId', UUID)

TransferHistoryId module-attribute

TransferHistoryId = NewType('TransferHistoryId', UUID)

TransferId module-attribute

TransferId = (
    CardTransferId
    | BankTransferId
    | AccountTransferId
    | InternalTransferId
)

TransferUpdateId module-attribute

TransferUpdateId = NewType('TransferUpdateId', UUID)

AccountTransfer dataclass

AccountTransfer(
    id,
    direction,
    reference,
    effective_date,
    account_id,
    transfer_history_id,
    updates,
    events,
    raw,
)

account_id instance-attribute

account_id

direction instance-attribute

direction

effective_date instance-attribute

effective_date

events instance-attribute

events

id instance-attribute

id

raw instance-attribute

raw

reference instance-attribute

reference

transfer_history_id instance-attribute

transfer_history_id

updates instance-attribute

updates

__post_init__

__post_init__()

Ensure datetimes are timezone-aware.

Source code in components/payment_gateway/subcomponents/transfers/protected/entities.py

def __post_init__(self) -> None:
    """Ensure datetimes are timezone-aware."""
    self.effective_date = sanitize_tz(self.effective_date)

BalanceInformation dataclass

BalanceInformation(received, reserved, balance)

balance instance-attribute

balance

received instance-attribute

received

reserved instance-attribute

reserved

BankTransfer dataclass

BankTransfer(
    id,
    external_id,
    direction,
    effective_date,
    account_id,
    transfer_history_id,
    updates,
    events,
    sepa_mandate_id,
    sepa_beneficiary_id,
    raw,
)

account_id instance-attribute

account_id

direction instance-attribute

direction

effective_date instance-attribute

effective_date

events instance-attribute

events

external_id instance-attribute

external_id

id instance-attribute

id

raw instance-attribute

raw

sepa_beneficiary_id instance-attribute

sepa_beneficiary_id

sepa_mandate_id instance-attribute

sepa_mandate_id

transfer_history_id instance-attribute

transfer_history_id

updates instance-attribute

updates

__post_init__

__post_init__()

Ensure datetimes are timezone-aware.

Source code in components/payment_gateway/subcomponents/transfers/protected/entities.py

def __post_init__(self) -> None:
    """Ensure datetimes are timezone-aware."""
    self.effective_date = sanitize_tz(self.effective_date)

BankTransferAccount dataclass

BankTransferAccount(
    bank_transfer_account_id,
    bank_transfer_account_info,
    bank_transfer_account_type,
)

Represents a bank account to which a bank transfer can be made (ex: BankAccountInfo in Canada).

bank_transfer_account_id instance-attribute

bank_transfer_account_id

bank_transfer_account_info instance-attribute

bank_transfer_account_info

bank_transfer_account_type instance-attribute

bank_transfer_account_type

CardPaymentMerchant dataclass

CardPaymentMerchant(
    merchant_id, name, mcc, postal_code, city, country_code
)

city instance-attribute

city

country_code instance-attribute

country_code

ISO 3166-1 alpha-3 country code

mcc instance-attribute

mcc

merchant_id instance-attribute

merchant_id

name instance-attribute

name

postal_code instance-attribute

postal_code

CardTransfer dataclass

CardTransfer(
    id,
    effective_date,
    merchant,
    card_id,
    account_id,
    updates,
    events,
    raw,
    transfer_history_id,
)

account_id instance-attribute

account_id

card_id instance-attribute

card_id

effective_date instance-attribute

effective_date

events instance-attribute

events

id instance-attribute

id

merchant instance-attribute

merchant

raw instance-attribute

raw

transfer_history_id instance-attribute

transfer_history_id

updates instance-attribute

updates

__post_init__

__post_init__()

Ensure datetimes are timezone-aware.

Source code in components/payment_gateway/subcomponents/transfers/protected/entities.py

def __post_init__(self) -> None:
    """Ensure datetimes are timezone-aware."""
    self.effective_date = sanitize_tz(self.effective_date)

InternalTransfer dataclass

InternalTransfer(
    id,
    effective_date,
    amount,
    description,
    reference,
    transfer_history_id,
)

amount instance-attribute

amount

description instance-attribute

description

effective_date instance-attribute

effective_date

id instance-attribute

id

reference instance-attribute

reference

transfer_history_id instance-attribute

transfer_history_id

__post_init__

__post_init__()

Ensure datetimes are timezone-aware.

Source code in components/payment_gateway/subcomponents/transfers/protected/entities.py

def __post_init__(self) -> None:
    """Ensure datetimes are timezone-aware."""
    self.effective_date = sanitize_tz(self.effective_date)

PayoutBankTransferTransaction dataclass

PayoutBankTransferTransaction(
    bank_transfer_id,
    external_transfer_id,
    external_transaction_id,
    is_submitted,
    amount,
    currency,
)

Represents the result of initiating a payout bank transfer.

amount instance-attribute

amount

bank_transfer_id instance-attribute

bank_transfer_id

currency instance-attribute

currency

external_transaction_id instance-attribute

external_transaction_id

external_transfer_id instance-attribute

external_transfer_id

is_submitted instance-attribute

is_submitted

RecipientAddress dataclass

RecipientAddress(street, postal_code, city, country)

Represents the address of a recipient (user or company).

city instance-attribute

city

country instance-attribute

country

postal_code instance-attribute

postal_code

street instance-attribute

street

RecipientUser dataclass

RecipientUser(profile_id, first_name, last_name, address)

Represents an individual recipient for a payout.

address instance-attribute

address

first_name instance-attribute

first_name

last_name instance-attribute

last_name

profile_id instance-attribute

profile_id

TransferEvent dataclass

TransferEvent(
    id,
    effective_date,
    received,
    reserved,
    balance,
    status,
    raw,
)

balance instance-attribute

balance

effective_date instance-attribute

effective_date

id instance-attribute

id

raw instance-attribute

raw

received instance-attribute

received

reserved instance-attribute

reserved

status instance-attribute

status

__post_init__

__post_init__()

Ensure datetimes are timezone-aware.

Source code in components/payment_gateway/subcomponents/transfers/protected/entities.py

def __post_init__(self) -> None:
    """Ensure datetimes are timezone-aware."""
    self.effective_date = sanitize_tz(self.effective_date)

TransferHistory dataclass

TransferHistory(id, private_type, private_ref, created_at)

created_at instance-attribute

created_at

id instance-attribute

id

private_ref instance-attribute

private_ref

private_type instance-attribute

private_type

TransferUpdate dataclass

TransferUpdate(
    id,
    transfer_id,
    transfer_type,
    direction,
    sequence_number,
    occurred_at,
    amount,
    currency,
    status,
    provider,
    external_transaction_id=None,
    external_transfer_id=None,
    raw=None,
)

amount instance-attribute

amount

currency instance-attribute

currency

direction instance-attribute

direction

external_transaction_id class-attribute instance-attribute

external_transaction_id = None

external_transfer_id class-attribute instance-attribute

external_transfer_id = None

id instance-attribute

id

occurred_at instance-attribute

occurred_at

provider instance-attribute

provider

raw class-attribute instance-attribute

raw = None

sequence_number instance-attribute

sequence_number

status instance-attribute

status

transfer_id instance-attribute

transfer_id

transfer_type instance-attribute

transfer_type

__post_init__

__post_init__()

Ensure datetimes are timezone-aware.

Source code in components/payment_gateway/subcomponents/transfers/protected/entities.py

def __post_init__(self) -> None:
    """Ensure datetimes are timezone-aware."""
    self.occurred_at = sanitize_tz(self.occurred_at)