Commands

Card Holders

declare_card_holder

Declare a new card holder

Usage:

declare_card_holder [OPTIONS] FIRST_NAME LAST_NAME

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_card_holder

Terminate the card holder

Usage:

terminate_card_holder [OPTIONS] CARD_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

Card Lifecycle

create_physical_card

Create a new physical card

This will create and order a new physical card on the Payment Service Provider linked to the given [ACCOUNT_ID]. The card display name will be inferred from the card holder name.

Physical cards require shipment info, contrary to virtual cards. A physical card can be shipped to a different name than the card holder, which is why the first and last name are required.

The card is inactive by default, and must be activated before it can be used. It is better to wait for delivery before doing so, in case the card is lost or stolen in transit.

Usage:

create_physical_card [OPTIONS] CARD_HOLDER_ID 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
--first_name	text	First name for shipment	_required
--last_name	text	Last name for shipment	_required
--address_line1	text	Street address for shipment	_required
--address_line2	text	Extra address information for shipment	None
--postal_code	text	Postal code for shipment	_required
--city	text	City for shipment	_required
--country	text	2-letter uppercase country code for shipment (e.g. FR, ES, BE...)	_required
--state_or_province	text	State or province for shipment (if applicable)	None
--phone_number	text	Phone number for delivery service (if applicable)	_required
--email	text	email for 3ds card authentication	None
--help	boolean	Show this message and exit.	False

create_virtual_card

Create a new virtual card

This will create a new virtual card on the Payment Service Provider linked to the given [ACCOUNT_ID]. The card display name will be inferred from the card holder name.

The card is inactive by default, and must be activated before it can be used.

Usage:

create_virtual_card [OPTIONS] CARD_HOLDER_ID ACCOUNT_ID PHONE_NUMBER [EMAIL]

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_card

Terminate the card

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

Usage:

terminate_card [OPTIONS] CARD_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

Card Status

activate_card

Activate the card

Newly created cards are inactive by default. This will activate the card and allow it to be used. It can also be used to reactivate a card that has been suspended.

Usage:

activate_card [OPTIONS] CARD_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

close_card

Close the card

This will close the card and prevent it from being used or reactivated.

Usage:

close_card [OPTIONS] CARD_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
--reason	text	N/A	_required
--help	boolean	Show this message and exit.	False

suspend_card

Suspend the card

This will suspend the card and prevent it from being used. The card can be reactivated later if needed.

Usage:

suspend_card [OPTIONS] CARD_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
--reason	text	N/A	_required
--help	boolean	Show this message and exit.	False

Card Incidents

declare_card_damaged

Declare that the card has been damaged

This will suspend the card and prevent it from being used.

Usage:

declare_card_damaged [OPTIONS] CARD_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

declare_card_lost

Declare that the card has been lost

This will suspend the card and prevent it from being used. The card can be reactivated later if it is found.

Usage:

declare_card_lost [OPTIONS] CARD_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

declare_card_stolen

Declare that the card has been stolen

This will suspend the card and prevent it from being used. The card can be reactivated later if it is found.

Usage:

declare_card_stolen [OPTIONS] CARD_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

Adyen-specific

Card orders

simulate_card_order_created

Simulate an inbound balancePlatform.cardorder.created webhook from Adyen

This builds a webhook data payload from the arguments and sends it to the card order tracking policy.

The main purpose of this command is to allow end-to-end testing of the card order tracking policy, as the Adyen test platform does not provide adequate tools for testing, like simulating card order status changes. As a consequence we can't assume we'll get webhooks on our staging platform for the whole card delivery lifecycle when creating physical cards from there.

Usage:

simulate_card_order_created [OPTIONS] PAYMENT_INSTRUMENT_ID {created|delivered
                            |notApplicable|processing|produced|rejected|shippe
                            d|unknown} SHIPPING_METHOD

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
--tracking_number	text	Optional tracking number (should be set when status is 'shipped')	None
--help	boolean	Show this message and exit.	False

simulate_card_order_updated

Simulate an inbound balancePlatform.cardorder.updated webhook from Adyen

This builds a webhook data payload from the arguments and sends it to the card order tracking policy.

The main purpose of this command is to allow end-to-end testing of the card order tracking policy, as the Adyen test platform does not provide adequate tools for testing, like simulating card order statßus changes. As a consequence we can't assume we'll get webhooks on our staging platform for the whole card delivery lifecycle when creating physical cards from there.

Usage:

simulate_card_order_updated [OPTIONS] PAYMENT_INSTRUMENT_ID {created|delivered
                            |notApplicable|processing|produced|rejected|shippe
                            d|unknown}

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
--tracking_number	text	Optional tracking number (should be set when status is 'shipped')	None
--help	boolean	Show this message and exit.	False

Cards

reveal_card

Reveal the card number, expiry date and CVC for a given payment instrument ID (cleartext)

The main purpose of this command is to get the necessary card details for simulating payments on the Adyen test platform.

The command cannot be used in production. A first check is done to prevent this, and since the undelying Adyen API call requires a specific role that is not supposed to be available in production, the command would fail anyway.

Tags: - @adyen: payment_instruments_api

Usage:

reveal_card [OPTIONS] PAYMENT_INSTRUMENT_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
--help	boolean	Show this message and exit.	False

reveal_pan

Reveal the PAN info for a given payment instrument ID (encrypted)

The main purpose of this command is to replicate the private PAN reveal flow used by the client app. It is not intended to be used in production, as it would reveal the card details.

Tags: - @adyen: payment_instrument_reveal_api

Usage:

reveal_pan [OPTIONS] PAYMENT_INSTRUMENT_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
--help	boolean	Show this message and exit.	False

reveal_pin

Reveal the PIN for a given payment instrument ID (encrypted, physical cards only)

The main purpose of this command is to replicate the private PIN reveal flow used by the client app. It is not intended to be used in production, as it would reveal the card details.

Tags: - @adyen: payment_instrument_reveal_api

Usage:

reveal_pin [OPTIONS] PAYMENT_INSTRUMENT_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
--help	boolean	Show this message and exit.	False

Payments

simulate_payment

Simulate a card payment on the Adyen test platform

This is done by making a call to the Checkout API, which in turn will send a series of transfer webhooks to the backend. The MCC will be the one configured for Alan's merchant account (currently 7999 for the test platform used in staging).

The command cannot be used in production.

Tags: - @adyen: payments_api

Usage:

simulate_payment [OPTIONS] AMOUNT_CENTS

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
--pan	text	N/A	_required
--expiry_month	text	N/A	_required
--expiry_year	text	N/A	_required
--cvc	text	N/A	_required
--reference	text	N/A	Alan simulated payment
--mcc	text	N/A	7999
--help	boolean	Show this message and exit.	False