Skip to content

Actions

components.payment_gateway.subcomponents.accounts.business_logic.actions.account_actions

AccountActions 

AccountActions(adyen_client)

This class contains all the actions used to manage the lifecycle of an account.

Implements the following Nullable patterns: - Nullables: https://www.jamesshore.com/v2/projects/nullables/testing-without-mocks#nullables ⧉ - Parameterless instantiation: https://www.jamesshore.com/v2/projects/nullables/testing-without-mocks#instantiation ⧉

Tags
Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
76
77
78
79
80
def __init__(
    self,
    adyen_client: "AdyenBalanceAccountsApiClient | None",
) -> None:
    self._adyen_client = adyen_client

activate_account 

activate_account(session, /, id)

Activate an account.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def activate_account(
    self,
    session: Session,
    /,
    id: AccountId,
) -> None:
    """
    Activate an account.
    """
    from shared.services.adyen.openapi.balance_platform_service_v2 import (
        BalanceAccountUpdateRequest,
    )

    with raise_if_account_not_found(id):
        account = AccountModelBroker.get_account(session, id=id)

    raise_on_terminated_account(account)
    raise_on_invalid_account_status_transition(account, AccountStatus.active)

    self.adyen_client.update_balance_account(
        account.external_id,
        request=BalanceAccountUpdateRequest(
            status="active",
        ),
        idempotency_key=None,  # TODO use this for retries
    )
    AccountModelBroker.set_account_status(
        session, id=account.id, status=AccountStatus.active
    )

adyen_client property 

adyen_client

Ensures the Adyen client is available when accessing it.

create classmethod 

create()

Normal factory

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@classmethod
def create(cls) -> "AccountActions":
    """Normal factory"""
    from shared.services.adyen.clients.adyen_balance_accounts_api_client import (
        AdyenBalanceAccountsApiClient,
    )
    from shared.services.adyen.clients.exceptions import (
        AdyenClientMissingCredentialsException,
    )

    try:
        adyen_client = AdyenBalanceAccountsApiClient.create()
    except AdyenClientMissingCredentialsException:
        adyen_client = None
    return cls(adyen_client)

create_account 

create_account(
    session,
    /,
    account_holder_id,
    description,
    reference=None,
)

Create an account for an account holder.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def create_account(
    self,
    session: Session,
    /,
    account_holder_id: AccountHolderId,
    description: str,
    reference: str | None = None,
) -> AccountId:
    """
    Create an account for an account holder.
    """
    from components.payment_gateway.subcomponents.accounts.adapters.adyen.helpers import (
        to_balance_account_info,
    )

    with raise_if_account_holder_not_found(account_holder_id):
        account_holder = AccountHolderModelBroker.get_account_holder(
            session,
            id=account_holder_id,
        )

    # 1. Create Adyen request payload from our model
    balance_account_info = to_balance_account_info(
        external_account_holder_id=account_holder.external_id,
        description=description,
        reference=reference,
    )
    assert balance_account_info.description is not None

    # 2. Call Adyen API
    balance_account = self.adyen_client.create_balance_account(
        request=balance_account_info,
        idempotency_key=None,  # TODO use this for retries
    )

    # 3. Create our Account entity from API result
    account = AccountModelBroker.create_account(
        session,
        description=balance_account_info.description,
        reference=balance_account_info.reference,
        provider=PaymentServiceProvider.adyen,
        external_id=balance_account.id,
        account_holder_id=account_holder_id,
        status=AccountStatus(balance_account.status),
    )
    return AccountId(account.id)

create_null classmethod 

create_null(track_adyen_requests=None)

Null factory

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
@classmethod
def create_null(
    cls,
    track_adyen_requests: list[tuple[str, dict, dict]] | None = None,  # type: ignore[type-arg]
) -> "AccountActions":
    """Null factory"""
    from shared.services.adyen.clients.adyen_balance_accounts_api_client import (
        AdyenBalanceAccountsApiClient,
    )

    return cls(
        AdyenBalanceAccountsApiClient.create_null(
            track_requests=track_adyen_requests
        )
    )

deactivate_account 

deactivate_account(session, /, id)

Deactivate an account.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def deactivate_account(
    self,
    session: Session,
    /,
    id: AccountId,
) -> None:
    """
    Deactivate an account.
    """
    from shared.services.adyen.openapi.balance_platform_service_v2 import (
        BalanceAccountUpdateRequest,
    )

    with raise_if_account_not_found(id):
        account = AccountModelBroker.get_account(session, id=id)

    raise_on_terminated_account(account)
    raise_on_invalid_account_status_transition(account, AccountStatus.inactive)

    self.adyen_client.update_balance_account(
        account.external_id,
        request=BalanceAccountUpdateRequest(
            status="inactive",
        ),
        idempotency_key=None,  # TODO use this for retries
    )
    AccountModelBroker.set_account_status(
        session, id=account.id, status=AccountStatus.inactive
    )

terminate_account 

terminate_account(session, /, id)

Terminate an account.

The operation is idempotent, i.e. it has no effect on already terminated entities.

Accounts in terminal state cannot be modified or used anymore. Any attempt to use or retrieve a terminated account will raise an AccountTerminatedException.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def terminate_account(
    self,
    session: Session,
    /,
    id: AccountId,
) -> None:
    """
    Terminate an account.

    The operation is idempotent, i.e. it has no effect on already terminated
    entities.

    Accounts in terminal state cannot be modified or used anymore. Any
    attempt to use or retrieve a terminated account will raise an
    `AccountTerminatedException`.
    """
    from shared.services.adyen.openapi.balance_platform_service_v2 import (
        BalanceAccountUpdateRequest,
    )

    with raise_if_account_not_found(id):
        account = AccountModelBroker.get_account(session, id=id)

    if account.status != AccountStatus.closed:
        # Terminating an account should close it at Adyen
        self.adyen_client.update_balance_account(
            account.external_id,
            request=BalanceAccountUpdateRequest(
                status="closed",
            ),
            idempotency_key=None,  # TODO use this for retries
        )
        AccountModelBroker.set_account_status(
            session, id=account.id, status=AccountStatus.closed
        )

    if not account.is_terminated:
        # Terminating an account should set its termination date on first call only
        AccountModelBroker.terminate_account(session, id=id)

update_account 

update_account(session, /, id, description, reference=None)

Update the balance account description and reference.

New description/name for the account will be truncated to 300 characters. New optional reference for the account will be truncated to 150 characters.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_actions.py 
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
def update_account(
    self,
    session: Session,
    /,
    id: AccountId,
    description: str,
    reference: str | None = None,
) -> None:
    """
    Update the balance account description and reference.

    New description/name for the account will be truncated to 300 characters.
    New optional reference for the account will be truncated to 150 characters.
    """
    from components.payment_gateway.subcomponents.accounts.adapters.adyen.helpers import (
        to_balance_account_info,
    )
    from shared.services.adyen.openapi.balance_platform_service_v2 import (
        BalanceAccountUpdateRequest,
    )

    with raise_if_account_not_found(id):
        account = AccountModelBroker.get_account(session, id=id)

    raise_on_terminated_account(account)

    balance_account_info = to_balance_account_info(
        external_account_holder_id=account.account_holder.external_id,
        description=description,
        reference=reference,
    )
    assert balance_account_info.description is not None

    self.adyen_client.update_balance_account(
        account.external_id,
        request=BalanceAccountUpdateRequest(
            description=balance_account_info.description,
            reference=balance_account_info.reference,
        ),
        idempotency_key=None,  # TODO use this for retries
    )

    # Update local database with new description and reference
    AccountModelBroker.update_account(
        session,
        id=account.id,
        description=balance_account_info.description,
        reference=balance_account_info.reference,
    )

components.payment_gateway.subcomponents.accounts.business_logic.actions.account_holder_actions

AccountHolderActions 

AccountHolderActions(
    adyen_account_holders_client,
    adyen_legal_entities_client,
)

This class contains all the actions related to account holders.

Implements the following Nullable patterns: - Nullables: https://www.jamesshore.com/v2/projects/nullables/testing-without-mocks#nullables ⧉ - Parameterless instantiation: https://www.jamesshore.com/v2/projects/nullables/testing-without-mocks#instantiation ⧉

Tags
Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_holder_actions.py 
82
83
84
85
86
87
88
def __init__(
    self,
    adyen_account_holders_client: "AdyenAccountHoldersApiClient | None",
    adyen_legal_entities_client: "AdyenLegalEntitiesApiClient | None",
) -> None:
    self._adyen_account_holders_client = adyen_account_holders_client
    self._adyen_legal_entities_client = adyen_legal_entities_client

adyen_account_holders_client property 

adyen_account_holders_client

Ensures the Adyen client is available when accessing it.

adyen_legal_entities_client

Ensures the Adyen client is available when accessing it.

create classmethod 

create()

Normal factory

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_holder_actions.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@classmethod
def create(cls) -> "AccountHolderActions":
    """Normal factory"""
    from shared.services.adyen.clients.adyen_account_holders_api_client import (
        AdyenAccountHoldersApiClient,
    )
    from shared.services.adyen.clients.adyen_legal_entities_api_client import (
        AdyenLegalEntitiesApiClient,
    )
    from shared.services.adyen.clients.exceptions import (
        AdyenClientMissingCredentialsException,
    )

    try:
        adyen_account_holders_client = AdyenAccountHoldersApiClient.create()
    except AdyenClientMissingCredentialsException:
        adyen_account_holders_client = None

    try:
        adyen_legal_entities_client = AdyenLegalEntitiesApiClient.create()
    except AdyenClientMissingCredentialsException:
        adyen_legal_entities_client = None

    return cls(
        adyen_account_holders_client,
        adyen_legal_entities_client,
    )

create_null classmethod 

create_null()

Null factory

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_holder_actions.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@classmethod
def create_null(cls) -> "AccountHolderActions":
    """Null factory"""
    from shared.services.adyen.clients.adyen_account_holders_api_client import (
        AdyenAccountHoldersApiClient,
    )
    from shared.services.adyen.clients.adyen_legal_entities_api_client import (
        AdyenLegalEntitiesApiClient,
    )

    return cls(
        AdyenAccountHoldersApiClient.create_null(),
        AdyenLegalEntitiesApiClient.create_null(),
    )

declare_account_holder 

declare_account_holder(
    session, /, description, external_id, reference=None
)

Declare an account holder.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_holder_actions.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def declare_account_holder(
    self,
    session: Session,
    /,
    description: str,
    external_id: str,
    reference: str | None = None,
) -> AccountHolderId:
    """
    Declare an account holder.
    """

    account_holder = AccountHolderModelBroker.create_account_holder(
        session,
        description=description,
        provider=PaymentServiceProvider.adyen,
        external_id=external_id,
        reference=reference,
    )
    return AccountHolderId(account_holder.id)

terminate_account_holder 

terminate_account_holder(session, /, id)

Terminate an account holder.

The operation is idempotent, i.e. it has no effect on already terminated entities.

Account holders in terminal state cannot be modified or used anymore. Any attempt to use or retrieve a terminated account holder will raise an AccountHolderTerminatedException.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_holder_actions.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def terminate_account_holder(
    self,
    session: Session,
    /,
    id: AccountHolderId,
) -> None:
    """
    Terminate an account holder.

    The operation is idempotent, i.e. it has no effect on already terminated
    entities.

    Account holders in terminal state cannot be modified or used anymore.
    Any attempt to use or retrieve a terminated account holder will raise an
    `AccountHolderTerminatedException`.
    """

    with raise_if_account_holder_not_found(id):
        account_holder = AccountHolderModelBroker.get_account_holder(session, id=id)

    if not account_holder.is_terminated:
        AccountHolderModelBroker.terminate_account_holder(session, id=id)

update_account_holder_legal_name(
    session, /, id, legal_name
)

Update the legal name of an account holder.

This method updates the legal name of an account holder in both the database and the third party API.

Source code in components/payment_gateway/subcomponents/accounts/business_logic/actions/account_holder_actions.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
def update_account_holder_legal_name(
    self,
    session: Session,
    /,
    id: AccountHolderId,
    legal_name: str,
) -> None:
    """
    Update the legal name of an account holder.

    This method updates the legal name of an account holder in both the
    database and the third party API.
    """
    from shared.services.adyen.openapi.legal_entity_service_v3 import (
        LegalEntityInfo,
    )

    with raise_if_account_holder_not_found(id):
        account_holder = AccountHolderModelBroker.get_account_holder(session, id=id)

    raise_on_terminated_account_holder(account_holder)

    # 1. Get legal entity ID from Adyen  # TODO @frederic.bonnet 2025-10-01 store it in the database? Depends on how it's done with other PSPs
    account_holder_data = self.adyen_account_holders_client.get_account_holder(
        id=account_holder.external_id
    )

    # 2. Get legal entity data from Adyen
    current_entity = self.adyen_legal_entities_client.get_legal_entity(
        id=account_holder_data.legalEntityId,
        idempotency_key=None,
    )

    # 3. Update legal entity name on Adyen
    assert current_entity.organization is not None, (
        "Legal entity must have an organization"
    )
    current_entity.organization.legalName = legal_name
    self.adyen_legal_entities_client.update_legal_entity(
        id=current_entity.id,
        request=LegalEntityInfo(
            type=current_entity.type, organization=current_entity.organization
        ),
    )