3.1.1.2. nordigen_cli.commands package

3.1.1.2.1. Submodules

3.1.1.2.2. nordigen_cli.commands.accounts module

nordigen_cli.commands.accounts.show_account(ctx: Context, account_id: UUID)

Access account metadata.

Information about the account record, such as the processing status and IBAN.

Account status is recalculated based on the error count in the latest req.

nordigen_cli.commands.accounts.show_account_balances(ctx: Context, account_id: UUID)

Access account balances.

Balances will be returned in Berlin Group PSD2 format.

nordigen_cli.commands.accounts.show_account_details(ctx: Context, account_id: UUID)

Access account details.

Account details will be returned in Berlin Group PSD2 format.

nordigen_cli.commands.accounts.show_account_transaction(ctx: Context, account_id: UUID)

Access account transactions.

Transactions will be returned in Berlin Group PSD2 format.

3.1.1.2.3. nordigen_cli.commands.agreements module

nordigen_cli.commands.agreements.accept_agreement(ctx: Context, agreement_id: UUID, user_agent, ip_address)

accept an end user agreement

nordigen_cli.commands.agreements.agreements_list(ctx: Context) → None

dump the configuration

nordigen_cli.commands.agreements.create_agreement(ctx: Context, bank_id, user_id, max_historical_days)

create an end user agreement (by bank ID and user ID)

nordigen_cli.commands.agreements.delete_agreement(ctx: Context, agreement_id: UUID)

Delete agreement based on its id

nordigen_cli.commands.agreements.show_agreement(ctx: Context, agreement_id: UUID)

end user agreement information

3.1.1.2.4. nordigen_cli.commands.approvals module

nordigen_cli.commands.approvals.create_approval(ctx: ~typer.models.Context, institution_id: str, reference: str = None, redirect: str = None, agreement: ~typing.Annotated[str | None, <typer.models.ArgumentInfo object at 0x7fb0c011df10>] = None, user_language: ~typing.Annotated[str | None, <typer.models.ArgumentInfo object at 0x7fb0c0f32f60>] = None, ssn: ~typing.Annotated[str | None, <typer.models.ArgumentInfo object at 0x7fb0c011dfa0>] = None, account_selection: bool | None = False, redirect_immediate: bool | None = False) → None

Create an approval flow (by bank ID and reference)

3.1.1.2.5. nordigen_cli.commands.banks module

nordigen_cli.commands.banks.list_banks(ctx: Context, country: str)

list banks by country code, COUNTRY is ‘GB’, ‘FR’ etc

nordigen_cli.commands.banks.show_bank(ctx: Context, bank_id: str)

[green]Show[/green] bank details by id

list of bank id can be obtained by “nordctl list-banks <2-letter country code>”

3.1.1.2.6. nordigen_cli.commands.callbacks module

nordigen_cli.commands.callbacks.id_callback(ctx: Context, value: str)

nordigen_cli.commands.callbacks.key_callback(ctx: Context, value: str)

3.1.1.2.7. nordigen_cli.commands.client module

nordigen_cli.commands.client.client_show(ctx: Context) → None

show the api client configuration

nordigen_cli.commands.client.get_client(settings)

nordigen_cli.commands.client.init_dirs(settings)

3.1.1.2.8. nordigen_cli.commands.config module

nordigen_cli.commands.config.config_dump(ctx: Context) → None

dump the configuration

Learn more at the [Typer docs website](https://typer.tiangolo.com)

nordigen_cli.commands.config.config_init(ctx: Context) → None

create the user initial configuration file

nordigen_cli.commands.config.config_reset(confirm: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fb0c0f31640>])

nordigen_cli.commands.config.config_show_tokens(ctx: Context) → None

3.1.1.2.9. nordigen_cli.commands.requisitions module

nordigen_cli.commands.requisitions.create_requisition(ctx: Context, redirect: str, institution_id: str, agreement: UUID | None, reference: str, user_language: str | None, ssn: str | None, account_selection: bool | None = False, redirect_immediate: bool | None = False)

Create a new requisition (by bank ID and reference)

nordigen_cli.commands.requisitions.delete_requisition(ctx: Context, requisition_id: UUID)

delete a requisition by ID

nordigen_cli.commands.requisitions.list_requisitions(ctx: Context)

list requisitions associated with company

nordigen_cli.commands.requisitions.show_requisition(ctx: Context, requisition_id: UUID)

[green]Retrieve a requisition by ID[/green]

3.1.1.2.10. Module contents