airwallex-sdk 0.1.0__py3-none-any.whl

airwallex/models/account.py

@@ -0,0 +1,51 @@
+"""
+Models for the Airwallex account API.
+"""
+from typing import Optional, List, Dict, Any
+from datetime import datetime
+from pydantic import Field
+from .base import AirwallexModel
+
+
+class AccountBalanceAmount(AirwallexModel):
+    """Model for account balance amount."""
+    currency: str = Field(..., description="Currency code (ISO 4217)")
+    value: float = Field(..., description="Balance amount value")
+
+
+class AccountBalance(AirwallexModel):
+    """Model for account balance."""
+    available_amount: AccountBalanceAmount = Field(..., description="Available account balance")
+    pending_amount: Optional[AccountBalanceAmount] = Field(None, description="Pending account balance")
+
+
+class Account(AirwallexModel):
+    """Model for an Airwallex account."""
+    resource_name: str = "accounts"
+    
+    id: str = Field(..., description="Unique account ID")
+    account_name: str = Field(..., description="Account name")
+    account_type: str = Field(..., description="Account type")
+    account_currency: str = Field(..., description="Account currency (ISO 4217)")
+    status: str = Field(..., description="Account status")
+    swift_code: Optional[str] = Field(None, description="SWIFT/BIC code")
+    iban: Optional[str] = Field(None, description="IBAN (International Bank Account Number)")
+    routing_number: Optional[str] = Field(None, description="Routing number")
+    account_number: Optional[str] = Field(None, description="Account number")
+    bsb: Optional[str] = Field(None, description="BSB (Bank State Branch code) for AU accounts")
+    sort_code: Optional[str] = Field(None, description="Sort code for UK accounts")
+    created_at: datetime = Field(..., description="Account creation timestamp")
+    updated_at: Optional[datetime] = Field(None, description="Account last update timestamp")
+    balance: Optional[AccountBalance] = Field(None, description="Account balance")
+    
+
+class AccountCreateRequest(AirwallexModel):
+    """Model for account creation request."""
+    account_name: str = Field(..., description="Name for the account")
+    account_currency: str = Field(..., description="Currency code (ISO 4217)")
+
+
+class AccountUpdateRequest(AirwallexModel):
+    """Model for account update request."""
+    account_name: Optional[str] = Field(None, description="New name for the account")
+    status: Optional[str] = Field(None, description="New status for the account")

airwallex/models/account_detail.py

@@ -0,0 +1,259 @@
+"""
+Models for the Airwallex Account Detail API.
+"""
+from typing import Optional, List, Dict, Any, Union
+from datetime import datetime
+from pydantic import Field, EmailStr
+from .base import AirwallexModel
+
+class Address(AirwallexModel):
+    """Model for an address."""
+    address_line1: str = Field(..., description="Address line 1")
+    address_line2: Optional[str] = Field(None, description="Address line 2")
+    country_code: str = Field(..., description="Country code (ISO 3166-1 alpha-2)")
+    postcode: str = Field(..., description="Postal code")
+    state: Optional[str] = Field(None, description="State or province")
+    suburb: Optional[str] = Field(None, description="Suburb or city")
+
+class BusinessIdentifier(AirwallexModel):
+    """Model for a business identifier."""
+    country_code: str = Field(..., description="Country code (ISO 3166-1 alpha-2)")
+    number: str = Field(..., description="Identifier number")
+    type: str = Field(..., description="Identifier type (e.g., 'BRN')")
+
+class EstimatedMonthlyRevenue(AirwallexModel):
+    """Model for estimated monthly revenue."""
+    amount: str = Field(..., description="Amount as string")
+    currency: str = Field(..., description="Currency code (ISO 4217)")
+
+class AccountUsage(AirwallexModel):
+    """Model for account usage information."""
+    estimated_monthly_revenue: EstimatedMonthlyRevenue = Field(..., description="Estimated monthly revenue")
+    product_reference: List[str] = Field(..., description="List of product references")
+
+class BusinessDocument(AirwallexModel):
+    """Model for a business document."""
+    description: Optional[str] = Field(None, description="Document description")
+    file_id: str = Field(..., description="File ID")
+    tag: str = Field(..., description="Document tag (e.g., 'BUSINESS_LICENSE')")
+
+class BusinessDocuments(AirwallexModel):
+    """Model for business documents."""
+    business_documents: List[BusinessDocument] = Field(..., description="List of business documents")
+
+class BusinessAttachments(AirwallexModel):
+    """Model for business attachments."""
+    business_documents: Optional[List[BusinessDocument]] = Field(None, description="List of business documents")
+
+class BusinessDetails(AirwallexModel):
+    """Model for business details."""
+    account_usage: AccountUsage = Field(..., description="Account usage information")
+    as_trustee: Optional[bool] = Field(None, description="Whether the business acts as a trustee")
+    attachments: Optional[BusinessAttachments] = Field(None, description="Business attachments")
+    business_address: Address = Field(..., description="Business address")
+    business_identifiers: List[BusinessIdentifier] = Field(..., description="Business identifiers")
+    business_name: str = Field(..., description="Business name")
+    business_name_english: Optional[str] = Field(None, description="Business name in English")
+    business_name_trading: Optional[str] = Field(None, description="Trading name of the business")
+    business_start_date: Optional[str] = Field(None, description="Business start date (YYYY-MM-DD)")
+    business_structure: str = Field(..., description="Business structure (e.g., 'COMPANY')")
+    contact_number: Optional[str] = Field(None, description="Contact phone number")
+    description_of_goods_or_services: Optional[str] = Field(None, description="Description of goods or services")
+    explanation_for_high_risk_countries_exposure: Optional[str] = Field(None, description="Explanation for high risk countries exposure")
+    has_nominee_shareholders: Optional[bool] = Field(None, description="Whether the business has nominee shareholders")
+    industry_category_code: str = Field(..., description="Industry category code")
+    no_shareholders_with_over_25percent: Optional[bool] = Field(None, description="Whether there are no shareholders with over 25% ownership")
+    operating_country: List[str] = Field(..., description="Operating countries (ISO 3166-1 alpha-2 codes)")
+    registration_address: Address = Field(..., description="Registration address")
+    registration_address_english: Optional[Address] = Field(None, description="Registration address in English")
+    state_of_incorporation: Optional[str] = Field(None, description="State of incorporation")
+    url: Optional[str] = Field(None, description="Business website URL")
+
+class DriversLicense(AirwallexModel):
+    """Model for driver's license identification."""
+    back_file_id: Optional[str] = Field(None, description="File ID for back of license")
+    effective_at: str = Field(..., description="Effective date (YYYY-MM-DD)")
+    expire_at: str = Field(..., description="Expiry date (YYYY-MM-DD)")
+    front_file_id: str = Field(..., description="File ID for front of license")
+    gender: Optional[str] = Field(None, description="Gender (e.g., 'F' for female)")
+    issuing_state: Optional[str] = Field(None, description="Issuing state")
+    number: str = Field(..., description="License number")
+    version: Optional[str] = Field(None, description="License version")
+
+class Passport(AirwallexModel):
+    """Model for passport identification."""
+    effective_at: str = Field(..., description="Effective date (YYYY-MM-DD)")
+    expire_at: str = Field(..., description="Expiry date (YYYY-MM-DD)")
+    front_file_id: str = Field(..., description="File ID for passport")
+    mrz_line1: Optional[str] = Field(None, description="MRZ line 1")
+    mrz_line2: Optional[str] = Field(None, description="MRZ line 2")
+    number: str = Field(..., description="Passport number")
+
+class PersonalId(AirwallexModel):
+    """Model for personal ID identification."""
+    back_file_id: Optional[str] = Field(None, description="File ID for back of ID")
+    effective_at: str = Field(..., description="Effective date (YYYY-MM-DD)")
+    expire_at: str = Field(..., description="Expiry date (YYYY-MM-DD)")
+    front_file_id: str = Field(..., description="File ID for front of ID")
+    number: str = Field(..., description="ID number")
+
+class PrimaryIdentification(AirwallexModel):
+    """Model for primary identification."""
+    drivers_license: Optional[DriversLicense] = Field(None, description="Driver's license details")
+    identification_type: str = Field(..., description="Identification type (e.g., 'PASSPORT')")
+    issuing_country_code: str = Field(..., description="Issuing country code (ISO 3166-1 alpha-2)")
+    passport: Optional[Passport] = Field(None, description="Passport details")
+    personal_id: Optional[PersonalId] = Field(None, description="Personal ID details")
+
+class Identifications(AirwallexModel):
+    """Model for identifications."""
+    primary: PrimaryIdentification = Field(..., description="Primary identification")
+
+class BusinessPersonDocument(AirwallexModel):
+    """Model for a business person document."""
+    description: Optional[str] = Field(None, description="Document description")
+    file_id: str = Field(..., description="File ID")
+    tag: str = Field(..., description="Document tag")
+
+class BusinessPersonAttachments(AirwallexModel):
+    """Model for business person attachments."""
+    business_person_documents: List[BusinessPersonDocument] = Field(..., description="List of business person documents")
+
+class BusinessPersonDetails(AirwallexModel):
+    """Model for business person details."""
+    attachments: Optional[BusinessPersonAttachments] = Field(None, description="Business person attachments")
+    date_of_birth: str = Field(..., description="Date of birth (YYYY-MM-DD)")
+    email: EmailStr = Field(..., description="Email address")
+    first_name: str = Field(..., description="First name")
+    first_name_english: Optional[str] = Field(None, description="First name in English")
+    identifications: Identifications = Field(..., description="Identifications")
+    last_name: str = Field(..., description="Last name")
+    last_name_english: Optional[str] = Field(None, description="Last name in English")
+    middle_name: Optional[str] = Field(None, description="Middle name")
+    middle_name_english: Optional[str] = Field(None, description="Middle name in English")
+    mobile: Optional[str] = Field(None, description="Mobile phone number")
+    residential_address: Optional[Address] = Field(None, description="Residential address")
+    residential_address_english: Optional[Address] = Field(None, description="Residential address in English")
+    role: str = Field(..., description="Role (e.g., 'DIRECTOR')")
+    title: Optional[str] = Field(None, description="Title (e.g., 'Mr')")
+
+class AdditionalFile(AirwallexModel):
+    """Model for an additional file."""
+    description: Optional[str] = Field(None, description="File description")
+    file_id: str = Field(..., description="File ID")
+    tag: str = Field(..., description="File tag")
+
+class AccountAttachments(AirwallexModel):
+    """Model for account attachments."""
+    additional_files: Optional[List[AdditionalFile]] = Field(None, description="List of additional files")
+
+class AccountDetails(AirwallexModel):
+    """Model for account details."""
+    attachments: Optional[AccountAttachments] = Field(None, description="Account attachments")
+    business_details: BusinessDetails = Field(..., description="Business details")
+    business_person_details: List[BusinessPersonDetails] = Field(..., description="Business person details")
+
+class CustomerAgreements(AirwallexModel):
+    """Model for customer agreements."""
+    tnc_accepted: bool = Field(..., description="Whether terms and conditions are accepted")
+    marketing_emails_opt_in: Optional[bool] = Field(None, description="Whether marketing emails are opted in")
+
+class PrimaryContact(AirwallexModel):
+    """Model for primary contact information."""
+    email: EmailStr = Field(..., description="Email address")
+    mobile: Optional[str] = Field(None, description="Mobile phone number")
+
+class NextAction(AirwallexModel):
+    """Model for next action information."""
+    type: str = Field(..., description="Action type")
+    message: Optional[str] = Field(None, description="Action message")
+
+class Requirements(AirwallexModel):
+    """Model for requirements information."""
+    current_deadline: Optional[str] = Field(None, description="Current deadline (ISO 8601 format)")
+    currently_due: List[str] = Field(..., description="List of currently due requirements")
+    eventually_due: List[str] = Field(..., description="List of eventually due requirements")
+    past_due: List[str] = Field(..., description="List of past due requirements")
+
+class AccountDetailModel(AirwallexModel):
+    """Model for an Airwallex account detail."""
+    resource_name: str = "accounts"
+    
+    account_details: Optional[AccountDetails] = Field(None, description="Account details")
+    created_at: str = Field(..., description="Account creation timestamp (ISO 8601 format)")
+    customer_agreements: Optional[CustomerAgreements] = Field(None, description="Customer agreements")
+    id: str = Field(..., description="Airwallex account ID")
+    identifier: Optional[str] = Field(None, description="Platform identifier for the merchant")
+    metadata: Optional[Dict[str, str]] = Field(None, description="Additional metadata")
+    next_action: Optional[NextAction] = Field(None, description="Next action information")
+    nickname: Optional[str] = Field(None, description="Human-friendly account name")
+    primary_contact: Optional[PrimaryContact] = Field(None, description="Primary contact information")
+    requirements: Optional[Requirements] = Field(None, description="Requirements information")
+    status: str = Field(..., description="Account status (CREATED, SUBMITTED, ACTION_REQUIRED, ACTIVE, SUSPENDED)")
+    view_type: Optional[str] = Field(None, description="View type information")
+
+# Request Models
+class AccountCreateRequest(AirwallexModel):
+    """Model for account creation request."""
+    account_details: Optional[AccountDetails] = Field(None, description="Account details")
+    customer_agreements: Optional[CustomerAgreements] = Field(None, description="Customer agreements")
+    identifier: Optional[str] = Field(None, description="Platform identifier for the merchant")
+    metadata: Optional[Dict[str, str]] = Field(None, description="Additional metadata")
+    nickname: Optional[str] = Field(None, description="Human-friendly account name")
+    primary_contact: Optional[PrimaryContact] = Field(None, description="Primary contact information")
+
+class AccountUpdateRequest(AirwallexModel):
+    """Model for account update request."""
+    account_details: Optional[AccountDetails] = Field(None, description="Account details")
+    metadata: Optional[Dict[str, str]] = Field(None, description="Additional metadata")
+    nickname: Optional[str] = Field(None, description="Human-friendly account name")
+
+# Amendments
+class StoreDetails(AirwallexModel):
+    """Model for store details."""
+    cross_border_transaction_percent: Optional[str] = Field(None, description="Cross-border transaction percentage")
+    dispute_percent: Optional[str] = Field(None, description="Dispute percentage")
+    employee_size: Optional[int] = Field(None, description="Employee size")
+    estimated_transaction_volume: Optional[Dict[str, Any]] = Field(None, description="Estimated transaction volume")
+    financial_statements: Optional[List[Dict[str, str]]] = Field(None, description="Financial statements")
+    fulfillment_days: Optional[int] = Field(None, description="Fulfillment days")
+    industry_code: Optional[str] = Field(None, description="Industry code")
+    mcc: Optional[str] = Field(None, description="Merchant Category Code")
+    operating_models: Optional[List[str]] = Field(None, description="Operating models")
+    payment_distribution: Optional[List[Dict[str, Any]]] = Field(None, description="Payment distribution")
+
+class Amendment(AirwallexModel):
+    """Model for an account amendment."""
+    resource_name: str = "account/amendments"
+    
+    id: str = Field(..., description="Amendment ID")
+    primary_contact: Optional[PrimaryContact] = Field(None, description="Primary contact information")
+    status: str = Field(..., description="Amendment status (PENDING, APPROVED, REJECTED)")
+    store_details: Optional[StoreDetails] = Field(None, description="Store details")
+    target: str = Field(..., description="Amendment target")
+
+class AmendmentCreateRequest(AirwallexModel):
+    """Model for amendment creation request."""
+    primary_contact: Optional[PrimaryContact] = Field(None, description="Primary contact information")
+    store_details: Optional[StoreDetails] = Field(None, description="Store details")
+    target: str = Field(..., description="Amendment target")
+
+# Wallet Info
+class WalletInfo(AirwallexModel):
+    """Model for wallet information."""
+    resource_name: str = "account/wallet_info"
+    
+    account_name: str = Field(..., description="Account name")
+    account_number: str = Field(..., description="Account number")
+
+# Terms and Conditions Agreement
+class DeviceData(AirwallexModel):
+    """Model for device data."""
+    ip_address: Optional[str] = Field(None, description="IP address")
+    user_agent: Optional[str] = Field(None, description="User agent")
+
+class TermsAndConditionsRequest(AirwallexModel):
+    """Model for terms and conditions agreement request."""
+    agreed_at: str = Field(..., description="Agreement timestamp (ISO 8601 format)")
+    device_data: Optional[DeviceData] = Field(None, description="Device data")
+    service_agreement_type: Optional[str] = Field("FULL", description="Service agreement type (FULL or RECIPIENT)")

airwallex/models/base.py

@@ -0,0 +1,121 @@
+"""
+Base Pydantic models for the Airwallex API.
+"""
+from typing import Any, Dict, List, Optional, ClassVar, Type, TypeVar, Generic, get_origin, get_args
+from datetime import datetime
+import re
+from pydantic import BaseModel, Field, ConfigDict, model_validator
+from ..utils import snake_to_camel_case, camel_to_snake_case
+
+T = TypeVar('T', bound='AirwallexModel')
+
+
+class AirwallexModel(BaseModel):
+    """Base model for all Airwallex API models with camelCase conversion."""
+    
+    model_config = ConfigDict(
+        populate_by_name=True,
+        extra='ignore',
+        arbitrary_types_allowed=True
+    )
+    
+    # Class variable to store the API resource name
+    resource_name: ClassVar[str] = ""
+    
+    @model_validator(mode='before')
+    @classmethod
+    def _convert_keys_to_snake_case(cls, data: Any) -> Any:
+        """Convert camelCase keys to snake_case."""
+        if not isinstance(data, dict):
+            return data
+            
+        result = {}
+        for key, value in data.items():
+            # Convert camelCase keys to snake_case
+            snake_key = camel_to_snake_case(key)
+            
+            # Handle nested dictionaries and lists
+            if isinstance(value, dict):
+                result[snake_key] = cls._convert_keys_to_snake_case(value)
+            elif isinstance(value, list) and all(isinstance(item, dict) for item in value):
+                result[snake_key] = [cls._convert_keys_to_snake_case(item) for item in value]
+            else:
+                result[snake_key] = value
+                
+        return result
+        
+    def to_api_dict(self) -> Dict[str, Any]:
+        """Convert the model to a dictionary with camelCase keys for API requests."""
+        data = self.model_dump(exclude_unset=True)
+        result: Dict[str, Any] = {}
+        
+        for key, value in data.items():
+            # Convert snake_case keys to camelCase
+            camel_key = snake_to_camel_case(key)
+            
+            # Handle nested models, dictionaries, and lists
+            if isinstance(value, AirwallexModel):
+                result[camel_key] = value.to_api_dict()
+            elif isinstance(value, dict):
+                # Convert dict keys to camelCase
+                nested_dict = {}
+                for k, v in value.items():
+                    if isinstance(v, AirwallexModel):
+                        nested_dict[snake_to_camel_case(k)] = v.to_api_dict()
+                    elif isinstance(v, list) and all(isinstance(item, AirwallexModel) for item in v):
+                        nested_dict[snake_to_camel_case(k)] = [item.to_api_dict() for item in v]
+                    else:
+                        nested_dict[snake_to_camel_case(k)] = v
+                result[camel_key] = nested_dict
+            elif isinstance(value, list):
+                # Handle lists of models
+                if all(isinstance(item, AirwallexModel) for item in value):
+                    result[camel_key] = [item.to_api_dict() for item in value]
+                else:
+                    result[camel_key] = value
+            elif isinstance(value, datetime):
+                # Convert datetime to ISO format
+                result[camel_key] = value.isoformat()
+            else:
+                result[camel_key] = value
+                
+        return result
+        
+    @classmethod
+    def from_api_response(cls: Type[T], data: Dict[str, Any]) -> T:
+        """Create a model instance from API response data."""
+        return cls.model_validate(cls._convert_keys_to_snake_case(data))
+
+
+# Common types used across the SDK
+class PaginationParams(AirwallexModel):
+    """Common pagination parameters."""
+    page: Optional[int] = Field(None, description="Page number (1-indexed)")
+    page_size: Optional[int] = Field(None, description="Number of items per page")
+
+
+class PaginatedResponse(AirwallexModel, Generic[T]):
+    """Base model for paginated responses."""
+    items: List[T] = Field(..., description="List of items")
+    page: int = Field(..., description="Current page number")
+    page_size: int = Field(..., description="Number of items per page")
+    total_count: int = Field(..., description="Total number of items")
+    total_pages: int = Field(..., description="Total number of pages")
+    
+    @classmethod
+    def from_api_response(cls, data: Dict[str, Any], item_class: Type[T]) -> 'PaginatedResponse[T]':
+        """Create a paginated response with the correct item type."""
+        # Extract the items and convert them to the specified model
+        items_data = data.get("items", [])
+        items = [item_class.from_api_response(item) for item in items_data]
+        
+        # Create the paginated response with the converted items
+        paginated_data = {
+            "items": items,
+            "page": data.get("page", 1),
+            "page_size": data.get("pageSize", len(items)),
+            "total_count": data.get("totalCount", len(items)),
+            "total_pages": data.get("totalPages", 1)
+        }
+        
+        return cls.model_validate(paginated_data)

airwallex/models/beneficiary.py

@@ -0,0 +1,70 @@
+"""
+Models for the Airwallex beneficiary API.
+"""
+from typing import Optional, List, Dict, Any, Union
+from datetime import datetime
+from pydantic import Field, EmailStr
+from .base import AirwallexModel
+
+
+class BankDetails(AirwallexModel):
+    """Model for bank account details."""
+    account_name: str = Field(..., description="Account holder name")
+    account_number: Optional[str] = Field(None, description="Account number")
+    swift_code: Optional[str] = Field(None, description="SWIFT/BIC code")
+    iban: Optional[str] = Field(None, description="IBAN (International Bank Account Number)")
+    bsb: Optional[str] = Field(None, description="BSB (Bank State Branch) for AU accounts")
+    sort_code: Optional[str] = Field(None, description="Sort code for UK accounts")
+    routing_number: Optional[str] = Field(None, description="ACH routing number for US accounts")
+    bank_name: Optional[str] = Field(None, description="Bank name")
+    bank_country_code: str = Field(..., description="Bank country code (ISO 3166-1 alpha-2)")
+    bank_address: Optional[Dict[str, str]] = Field(None, description="Bank address details")
+
+
+class Address(AirwallexModel):
+    """Model for address details."""
+    country_code: str = Field(..., description="Country code (ISO 3166-1 alpha-2)")
+    state: Optional[str] = Field(None, description="State or province")
+    city: str = Field(..., description="City")
+    postcode: Optional[str] = Field(None, description="Postal or ZIP code")
+    street_address: str = Field(..., description="Street address")
+    street_address_2: Optional[str] = Field(None, description="Additional street address details")
+
+
+class Beneficiary(AirwallexModel):
+    """Model for an Airwallex beneficiary."""
+    resource_name: str = "beneficiaries"
+    
+    id: str = Field(..., description="Unique beneficiary ID")
+    name: str = Field(..., description="Beneficiary name")
+    type: str = Field(..., description="Beneficiary type (e.g., 'bank_account', 'email')")
+    email: Optional[EmailStr] = Field(None, description="Beneficiary email address")
+    bank_details: Optional[BankDetails] = Field(None, description="Bank account details for bank_account type")
+    address: Optional[Address] = Field(None, description="Beneficiary address")
+    company_name: Optional[str] = Field(None, description="Beneficiary company name")
+    entity_type: Optional[str] = Field(None, description="Beneficiary entity type (individual/company)")
+    payment_methods: List[str] = Field(default_factory=list, description="Supported payment methods")
+    status: str = Field(..., description="Beneficiary status")
+    created_at: datetime = Field(..., description="Beneficiary creation timestamp")
+    updated_at: Optional[datetime] = Field(None, description="Beneficiary last update timestamp")
+
+
+class BeneficiaryCreateRequest(AirwallexModel):
+    """Model for beneficiary creation request."""
+    name: str = Field(..., description="Beneficiary name")
+    type: str = Field(..., description="Beneficiary type (e.g., 'bank_account', 'email')")
+    email: Optional[EmailStr] = Field(None, description="Beneficiary email address")
+    bank_details: Optional[BankDetails] = Field(None, description="Bank account details for bank_account type")
+    address: Optional[Address] = Field(None, description="Beneficiary address")
+    company_name: Optional[str] = Field(None, description="Beneficiary company name")
+    entity_type: Optional[str] = Field(None, description="Beneficiary entity type (individual/company)")
+
+
+class BeneficiaryUpdateRequest(AirwallexModel):
+    """Model for beneficiary update request."""
+    name: Optional[str] = Field(None, description="Updated beneficiary name")
+    email: Optional[EmailStr] = Field(None, description="Updated beneficiary email address")
+    bank_details: Optional[BankDetails] = Field(None, description="Updated bank account details")
+    address: Optional[Address] = Field(None, description="Updated beneficiary address")
+    company_name: Optional[str] = Field(None, description="Updated beneficiary company name")
+    status: Optional[str] = Field(None, description="Updated beneficiary status")

airwallex/models/financial_transaction.py

@@ -0,0 +1,30 @@
+"""
+Models for the Airwallex financial transaction API.
+"""
+from typing import Optional
+from datetime import datetime
+from pydantic import Field
+from .base import AirwallexModel
+
+
+class FinancialTransaction(AirwallexModel):
+    """Model for an Airwallex financial transaction."""
+    resource_name: str = "financial_transactions"
+    
+    id: str = Field(..., description="ID of the transaction")
+    amount: float = Field(..., description="Gross amount of the transaction")
+    net: float = Field(..., description="Net amount of the transaction")
+    fee: float = Field(..., description="Fee paid for the transaction")
+    currency: str = Field(..., description="Currency of the transaction (3-letter ISO-4217 code)")
+    status: str = Field(..., description="Status of the transaction (PENDING, SETTLED, CANCELLED)")
+    description: Optional[str] = Field(None, description="Description of the transaction")
+    batch_id: Optional[str] = Field(None, description="Batch ID of the settlement the transaction belongs to")
+    client_rate: Optional[float] = Field(None, description="Client rate for the transaction")
+    currency_pair: Optional[str] = Field(None, description="Currency pair that the client_rate is quoted in")
+    source_id: Optional[str] = Field(None, description="Source ID of the transaction")
+    source_type: Optional[str] = Field(None, description="Type of the source transaction")
+    transaction_type: Optional[str] = Field(None, description="Type of the transaction")
+    funding_source_id: Optional[str] = Field(None, description="ID of the funding source")
+    created_at: datetime = Field(..., description="Transaction creation timestamp")
+    estimated_settled_at: Optional[datetime] = Field(None, description="Estimated settlement timestamp")
+    settled_at: Optional[datetime] = Field(None, description="Actual settlement timestamp")

airwallex/models/fx.py

@@ -0,0 +1,58 @@
+"""
+Models for the Airwallex FX API.
+"""
+from typing import Optional, List, Dict, Any
+from datetime import datetime
+from pydantic import Field
+from .base import AirwallexModel
+
+
+class ExchangeRate(AirwallexModel):
+    """Model for exchange rate information."""
+    source_currency: str = Field(..., description="Source currency code (ISO 4217)")
+    target_currency: str = Field(..., description="Target currency code (ISO 4217)")
+    rate: float = Field(..., description="Exchange rate")
+    timestamp: datetime = Field(..., description="Timestamp when the rate was fetched")
+
+
+class FXQuote(AirwallexModel):
+    """Model for FX quote."""
+    id: str = Field(..., description="Quote ID")
+    source_currency: str = Field(..., description="Source currency code (ISO 4217)")
+    target_currency: str = Field(..., description="Target currency code (ISO 4217)")
+    source_amount: Optional[float] = Field(None, description="Source amount")
+    target_amount: Optional[float] = Field(None, description="Target amount")
+    rate: float = Field(..., description="Exchange rate")
+    fee: Optional[Dict[str, Any]] = Field(None, description="Fee details")
+    expires_at: datetime = Field(..., description="Quote expiration timestamp")
+    created_at: datetime = Field(..., description="Quote creation timestamp")
+
+
+class FXConversion(AirwallexModel):
+    """Model for an FX conversion."""
+    resource_name: str = "fx/conversions"
+    
+    id: str = Field(..., description="Conversion ID")
+    request_id: str = Field(..., description="Client-generated request ID")
+    source_currency: str = Field(..., description="Source currency code (ISO 4217)")
+    target_currency: str = Field(..., description="Target currency code (ISO 4217)")
+    source_amount: float = Field(..., description="Source amount")
+    target_amount: float = Field(..., description="Target amount")
+    rate: float = Field(..., description="Exchange rate")
+    status: str = Field(..., description="Conversion status")
+    created_at: datetime = Field(..., description="Conversion creation timestamp")
+    updated_at: Optional[datetime] = Field(None, description="Conversion last update timestamp")
+    account_id: str = Field(..., description="Source account ID")
+    settlement_date: Optional[datetime] = Field(None, description="Settlement date")
+    quote_id: Optional[str] = Field(None, description="Quote ID used for this conversion")
+
+
+class FXConversionCreateRequest(AirwallexModel):
+    """Model for FX conversion creation request."""
+    request_id: str = Field(..., description="Client-generated unique ID for the request")
+    source_currency: str = Field(..., description="Source currency code (ISO 4217)")
+    target_currency: str = Field(..., description="Target currency code (ISO 4217)")
+    source_amount: Optional[float] = Field(None, description="Source amount (required if target_amount is not provided)")
+    target_amount: Optional[float] = Field(None, description="Target amount (required if source_amount is not provided)")
+    account_id: str = Field(..., description="Source account ID")
+    quote_id: Optional[str] = Field(None, description="Quote ID to use for this conversion")