Skip to content

Commands

payment_gateway

Main command group for the Payment Gateway component.

Usage:

payment_gateway [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

payment_gateway 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:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway adyen

Adyen-specific commands for debugging and testing

Usage:

payment_gateway adyen [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

payment_gateway adyen audit_transfer_webhooks

Audit Adyen transfer webhooks to ensure that all transfers are processed

This command will iterate over all Adyen transfer webhooks stored in the database as WebhookLog and check if all transfers and transfer events have been processed. To do so, it will check if the transfer and transfer event IDs are present in the database. All missing entities will be logged as errors.

Transfer webhooks use the following types:

  • balancePlatform.transfer.created
  • balancePlatform.transfer.updated

Transfer events are stored in the TransferEvent table.

Transfers are stored in the following tables depending on the transfer type:

  • CardTransfer for transfers of type payment
  • BankTransfer for transfers of type bankTransfer
  • AccountTransfer for transfers of type internalTransfer Other types are unhandled.

All models have an external_id field that can be used to match the transfer and transfer event IDs.

Usage:

payment_gateway adyen audit_transfer_webhooks [OPTIONS]

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
--start-date datetime (%Y-%m-%d) Start date (inclusive) None
--end-date datetime (%Y-%m-%d) End date (exclusive) None
-cp, --card-transfers boolean Include card transfers False
-bt, --bank-transfers boolean Include bank transfers False
-at, --account-transfers boolean Include account transfers False
--help boolean Show this message and exit. False

payment_gateway adyen onboard_company

Initiate onboarding of a company on Adyen

  • Create a legal entity
  • Create an account holder

Usage:

payment_gateway adyen onboard_company [OPTIONS] LEGAL_NAME COMPANY_NIF

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
--org_type choice (associationIncorporated | governmentalOrganization | listedPublicCompany | nonProfit | partnershipIncorporated | privateCompany) N/A _required
--street text Company street address _required
--street2 text Company extra address information None
--postal_code text Company postal code _required
--city text Company city _required
--country text 2-letter uppercase company country code (e.g. FR, ES, BE...) _required
--state_or_province text Company state or province (if applicable) None
--help boolean Show this message and exit. False

payment_gateway adyen 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:

payment_gateway adyen 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

payment_gateway adyen 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:

payment_gateway adyen 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

payment_gateway adyen 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:

payment_gateway adyen 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

payment_gateway adyen 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:

payment_gateway adyen simulate_card_order_created [OPTIONS]
                                                  PAYMENT_INSTRUMENT_ID {creat
                                                  ed|delivered|notApplicable|p
                                                  rocessing|produced|rejected|
                                                  shipped|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

payment_gateway adyen 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:

payment_gateway adyen simulate_card_order_updated [OPTIONS]
                                                  PAYMENT_INSTRUMENT_ID {creat
                                                  ed|delivered|notApplicable|p
                                                  rocessing|produced|rejected|
                                                  shipped|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

payment_gateway adyen simulate_card_payment_transfer_created

Simulate an inbound balancePlatform.transfer.created webhook from Adyen resulting from a card payment

This builds a webhook data payload from the arguments and publishes it on the adyen_transfer_topic for downstream processing.

The main purpose of this command is to allow end-to-end testing of the CardTransferProcessorPolicy, as the Adyen test platform does not provide adequate tools for testing that would cover all our business rules. Indeed the existing simulate_payment command uses Alan's merchant account and there's no way for us to change it. Moveover, we don't control the timing of the successive events which can span several hours or days.

This command will also help us improve the resilience of our code under adverse conditions, like high loadß or out-of-order events.

Usage:

payment_gateway adyen simulate_card_payment_transfer_created 
    [OPTIONS]

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
--seed text Random seed to use for generating bogus data (if not provided, a random one will be generated) None
--amount_cents text Amount of the transfer in cents (default=100) 100
--merchant_mcc text MCC of the merchant (default=randomly chosen among known MCCs) None
--payment_instrument_id text Payment instrument ID of the card (if not provided, a bogus one will be generated) None
--help boolean Show this message and exit. False

payment_gateway adyen 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:

payment_gateway adyen 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

payment_gateway audit_transfers

Usage:

payment_gateway audit_transfers [OPTIONS]

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
--s3-bucket text N/A es-api
--csv-url text N/A _required
--account-id text N/A _required
--from-date datetime (%Y-%m-%d) From date since when to audit transfers None
--help boolean Show this message and exit. False

payment_gateway backfill_transfer_update_amount

Backfill amount and currency fields in card TransferUpdate records from raw JSON data.

This command extracts the amount and currency from the raw JSON data using the same logic as the transfer processors and populates these fields for records that need updating.

Usage:

payment_gateway backfill_transfer_update_amount [OPTIONS]

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
--batch-size integer Number of records to process per batch 100
--help boolean Show this message and exit. False

payment_gateway close_card

Close the card

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

Usage:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway create_transfer_history

Create a new transfer history

Usage:

payment_gateway create_transfer_history [OPTIONS] PRIVATE_TYPE PRIVATE_REF

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

payment_gateway 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:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway deactivate_all_account_transaction_rules

Deactivate all transaction rules associated with balance accounts on Adyen.

This command iterates over all accounts in our database, gets their transaction rules from Adyen, and deactivates active rules on Adyen.

The command processes accounts in batches to handle large datasets efficiently.

Usage:

payment_gateway deactivate_all_account_transaction_rules [OPTIONS]

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
--batch-size integer Number of accounts to process in each batch (default: 100) 100
--help boolean Show this message and exit. False

payment_gateway deactivate_all_card_transaction_rules

Deactivate all transaction rules associated with payment instruments on Adyen.

This command iterates over all cards in our database, gets their transaction rules from Adyen, and deactivates active rules on Adyen.

The command processes cards in batches to handle large datasets efficiently.

Tags: - @adyen: payment_instruments_api - @adyen: transaction_rules_api

Usage:

payment_gateway deactivate_all_card_transaction_rules [OPTIONS]

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
--batch-size integer Number of cards to process in each batch (default: 100) 100
--help boolean Show this message and exit. False

payment_gateway 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:

payment_gateway 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

payment_gateway declare_card_damaged

Declare that the card has been damaged

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

Usage:

payment_gateway 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

payment_gateway declare_card_holder

Declare a new card holder

Usage:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway terminate_account_holder

Terminate the account holder

Usage:

payment_gateway 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

payment_gateway 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:

payment_gateway 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

payment_gateway terminate_card_holder

Terminate the card holder

Usage:

payment_gateway 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

payment_gateway update_account

Update an account

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

Usage:

payment_gateway 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

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:

payment_gateway 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