Api reference

components.alan_pay.public.business_logic ¶

alan_pay_actions ¶

AlanPayActions ¶

Public actions interface with the Alan Pay component.

declare_profile `staticmethod` ¶

declare_profile(app_id, app_user_id, save=True)

Create a new Alan Pay profile for the given user, and return its ID.

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def declare_profile(app_id: str, app_user_id: str, save: bool = True) -> UUID:
    """
    Create a new Alan Pay profile for the given user, and return its ID.
    """
    with no_commit_in_session(
        commit_at_end=save, silent=True, rollback_at_end=False
    ):
        # Create the Alan Pay profile
        profile = save_alan_pay_profile(
            app_id=app_id,
            app_user_id=app_user_id,
            save=False,
        )
        # Flush to enforce the profile ID creation
        current_session.flush()

        # Also create the related transfer history, used to link all card payments and bank transfers to the profile
        save_transfer_history(
            profile_id=profile.id,
            save=False,
        )

    return profile.id

declare_sepa_mandate `classmethod` ¶

declare_sepa_mandate(
    app_id,
    app_user_id,
    debtor_name,
    debtor_iban,
    debtor_country,
    unique_mandate_reference,
    signature_date,
    save=True,
)

Declare a SEPA mandate for the given user.

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@classmethod
def declare_sepa_mandate(
    cls,
    app_id: str,
    app_user_id: str,
    debtor_name: str,
    debtor_iban: str,
    debtor_country: str,
    unique_mandate_reference: str,
    signature_date: date,
    save: bool = True,
) -> None:
    """
    Declare a SEPA mandate for the given user.
    """
    # Fetch target profile
    profile = get_alan_pay_profile(app_id=app_id, app_user_id=app_user_id)
    if profile is None:
        raise ValueError(
            f"Profile not found for app [{app_id}] and user [{app_user_id}]"
        )

    # Map to CCA33
    country_code = cls._get_country_code_from_string(country=debtor_country)

    # Run action
    declare_sepa_mandate(
        alan_pay_profile_id=profile.id,
        debtor_name=debtor_name,
        debtor_iban=debtor_iban,
        debtor_country=country_code,
        unique_mandate_reference=unique_mandate_reference,
        signature_date=signature_date,
        save=save,
    )

offboard_user `staticmethod` ¶

offboard_user(app_id, app_user_id)

Offboard an existing user from Alan Pay.

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def offboard_user(
    app_id: str,
    app_user_id: str,
) -> None:
    """
    Offboard an existing user from Alan Pay.
    """
    # Fetch target profile
    profile = get_alan_pay_profile(app_id=app_id, app_user_id=app_user_id)
    if profile is None:
        raise ValueError(
            f"Profile not found for app [{app_id}] and user [{app_user_id}]"
        )

    offboard_alan_pay_profile(profile_id=profile.id)

onboard_user `staticmethod` ¶

onboard_user(
    app_id,
    app_user_id,
    phone_number_verification_request_id,
    phone_number_otp_code,
    first_name,
    last_name,
    birth_date,
    email,
    lang,
)

Onboard a new user on Alan Pay by: - Verifying its phone number using the OTP (One Time Password) they received - Creating a new account membership and a card

Raises an InvalidPhoneNumberVerificationCodeException if the OTP is invalid

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def onboard_user(
    app_id: str,
    app_user_id: str,
    phone_number_verification_request_id: str,
    phone_number_otp_code: str,
    first_name: str,
    last_name: str,
    birth_date: date,
    email: str,
    lang: Lang,
) -> None:
    """
    Onboard a new user on Alan Pay by:
    - Verifying its phone number using the OTP (One Time Password) they received
    - Creating a new account membership and a card

    Raises an InvalidPhoneNumberVerificationCodeException if the OTP is invalid
    """
    # Fetch target profile
    profile = get_alan_pay_profile(app_id=app_id, app_user_id=app_user_id)
    if profile is None:
        raise ValueError(
            f"Profile not found for app [{app_id}] and user [{app_user_id}]"
        )

    onboard_user_from_phone_number_verification(
        profile_id=profile.id,
        request_id=phone_number_verification_request_id,
        code=phone_number_otp_code,
        first_name=first_name,
        last_name=last_name,
        birth_date=birth_date,
        email=email,
        lang=lang,
    )

request_external_transaction `staticmethod` ¶

request_external_transaction(
    app_id,
    app_user_id,
    transaction_date,
    requested_amount_in_cents,
    external_transaction_id,
    save=True,
)

Request creation of a new external transaction for the given user. - If user has no debt to Alan (ex: no recent card payment), no transaction will be created - If user has a debt to Alan, a new transaction will be created, whose amount will be the min value between the user debt and requested_amount_in_cents

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def request_external_transaction(
    app_id: str,
    app_user_id: str,
    transaction_date: datetime,
    requested_amount_in_cents: int,
    external_transaction_id: str,
    save: bool = True,
) -> InMemoryAlanBalanceTransaction | None:
    """
    Request creation of a new external transaction for the given user.
    - If user has no debt to Alan (ex: no recent card payment), no transaction will be created
    - If user has a debt to Alan, a new transaction will be created, whose amount will be the min value between the user debt and `requested_amount_in_cents`
    """
    # Do NOT create any new transaction if we don't know anything about the user
    profile = get_alan_pay_profile(app_id=app_id, app_user_id=app_user_id)
    if not profile:
        return None

    # Request an addition to the Alan Balance
    transaction = request_external_transaction(
        profile_id=profile.id,
        requested_amount_in_cents=requested_amount_in_cents,
        external_transaction_id=external_transaction_id,
        transaction_date=transaction_date,
        save=save,
    )

    current_session.flush()  # Flush to enforce the transaction ID creation used in the in-memory mapping

    return (
        map_alan_balance_transaction(transaction=transaction)
        if transaction is not None
        else None
    )

set_push_notification_date_for_external_transactions `staticmethod` ¶

set_push_notification_date_for_external_transactions(
    transaction_ids, push_notification_sent_at
)

Update the date a push notification was sent for the given external transactions.

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def set_push_notification_date_for_external_transactions(
    transaction_ids: list[UUID],
    push_notification_sent_at: datetime,
) -> list[InMemoryAlanBalanceTransaction]:
    """
    Update the date a push notification was sent for the given external transactions.
    """
    transactions = set_push_notification_date_for_external_transactions(
        transaction_ids=transaction_ids,
        push_notification_sent_at=push_notification_sent_at,
    )

    return [
        map_alan_balance_transaction(transaction=transaction)
        for transaction in transactions
    ]

start_phone_number_verification `staticmethod` ¶

start_phone_number_verification(phone_number, lang)

Start phone number verification by sending a OTP (One Time Password) to the given phone number.

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def start_phone_number_verification(
    phone_number: str,
    lang: Lang,
) -> InMemoryAlanPayPhoneNumberVerification:
    """
    Start phone number verification by sending a OTP (One Time Password) to the given phone number.
    """
    return start_alan_pay_phone_number_verification(
        phone_number=phone_number, lang=lang
    )

view_card_numbers `staticmethod` ¶

view_card_numbers(app_id, app_user_id)

Returns the numbers of the latest active card of the given user.

Source code in components/alan_pay/public/business_logic/alan_pay_actions.py

@staticmethod
def view_card_numbers(
    app_id: str,
    app_user_id: str,
) -> InMemoryAlanPayCardNumbers:
    """
    Returns the numbers of the latest active card of the given user.
    """
    from components.alan_pay.internal.business_logic.actions.alan_pay_card import (
        get_alan_pay_card_numbers,
    )

    # Fetch target profile
    profile = get_alan_pay_profile(app_id=app_id, app_user_id=app_user_id)
    if profile is None:
        raise ValueError(
            f"Profile not found for app [{app_id}] and user [{app_user_id}]"
        )

    return get_alan_pay_card_numbers(profile_id=profile.id)

alan_pay_queries ¶

AlanPayQueries ¶

Public queries interface with the Alan Pay component.