Commands

Account Holders

declare_account_holder

Declare a new account holder

This will create a local account holder linked to an existing Payment Service Provider entity given by [EXTERNAL_ID].

Usage:

declare_account_holder [OPTIONS] DESCRIPTION EXTERNAL_ID

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--reference	text	N/A	None
--help	boolean	Show this message and exit.	False

terminate_account_holder

Terminate the account holder

Usage:

terminate_account_holder [OPTIONS] ACCOUNT_HOLDER_ID

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--help	boolean	Show this message and exit.	False

update_legal_name

Update the legal entity's name of a given account holder. Legal name is updated in the Payment Service Provider (PSP) entity and in the local database.

Usage:

update_legal_name [OPTIONS] ACCOUNT_HOLDER_ID

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--legal_name	text	N/A	_required
--help	boolean	Show this message and exit.	False

Accounts

activate_account

Activate the account

This will activate the account on the Payment Service Provider side, making it possible to create cards linked to it.

Usage:

activate_account [OPTIONS] ACCOUNT_ID

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--help	boolean	Show this message and exit.	False

create_account

Create a new account

This will create a new account on the Payment Service Provider linked to the given account holder.

The account is active by default.

Usage:

create_account [OPTIONS] ACCOUNT_HOLDER_ID DESCRIPTION

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--reference	text	N/A	None
--help	boolean	Show this message and exit.	False

deactivate_account

Deactivate the account

This will deactivate the account on the Payment Service Provider side, making it impossible to create cards linked to it.

Usage:

deactivate_account [OPTIONS] ACCOUNT_ID

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--help	boolean	Show this message and exit.	False

terminate_account

Terminate the account

This will close the account on the Payment Service Provider side, and prevent it from being used. This operation is irreversible.

Usage:

terminate_account [OPTIONS] ACCOUNT_ID

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--help	boolean	Show this message and exit.	False

update_account

Update an account

This command will update the description and reference for an account on adyen

Usage:

update_account [OPTIONS] ACCOUNT_ID DESCRIPTION

Options:

Name	Type	Description	Default
-k, --use-kay-data	boolean	Use remote database with anonymized production dump	False
--use-shared-kay	boolean	Use a Kay database shared with all engineers, refreshed daily	False
--use-kay	choice (personal | shared | on_aurora)	Use Kay database: 'personal' for your own database, 'shared' for the shared Kay database, 'on-aurora' for Kay on Aurora	None
--profile-memory	boolean	Memory usage profiler is activated	False
--profile-methods-dump	boolean	Activate profiler for method calls and output one .prof file per run	False
--profile-methods	boolean	Activate profiler for method calls	False
--tracking	boolean	Activate tracking on dev environment	False
-m, --mailer	boolean	Activate mailer on dev environment	False
--debug-transactions	boolean	Print transaction debug information	False
--show-logs / --hide-logs	boolean	Display application logs in the console. Don't use on detached one-offs to avoid duplicated logs.	None
--monitor	boolean	Monitor command and send a notification to Slack if it fails	False
--dry-run / --execute	boolean	Perform a dry run (default) or a live run	True
--reference	text	N/A	None
--help	boolean	Show this message and exit.	False