Docstring Tags Index¶

This page demonstrates the usage of docstring tags throughout the codebase.

Custom Tags Index¶

Available Tags Summary¶

Found 3 different tags across 47 objects.

All Custom Tags¶

adyen (34 occurrences)¶

[components.es.internal.controllers.company.CompanyAdyenOnboardingController.get][]
[components.es.subcomponents.healthy_benefits.internal.business_logic.create_company_balance_account.create_company_balance_account][]
[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenAuthorisationWebhookController][]
[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenCardOrderWebhookController][]
[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenConfigurationWebhookController][]
[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenTransferWebhookController][]
[components.payment_gateway.public.onboard_legal_entity.onboard_legal_entity][]
components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_actions.AccountActions
components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_holder_actions.AccountHolderActions
components.payment_gateway.subcomponents.cards.business_logic.actions.card_authentication_actions.CardAuthenticationActions
components.payment_gateway.subcomponents.cards.business_logic.actions.card_incidents_actions.CardIncidentsActions
components.payment_gateway.subcomponents.cards.business_logic.actions.card_lifecycle_actions.CardLifecycleActions
components.payment_gateway.subcomponents.cards.business_logic.actions.card_status_actions.CardStatusActions
components.payment_gateway.subcomponents.cards.business_logic.queries.card_reveal_queries.CardRevealQueries
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_card][]
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pan][]
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pin][]
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.payments.simulate_payment][]
components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions
[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit][]
components.payment_gateway.subcomponents.rules.business_logic.actions.expense_limit_rule_actions.ExpenseLimitRuleActions
components.payment_gateway.subcomponents.rules.business_logic.actions.usage_restriction_rule_actions.UsageRestrictionRuleActions
[components.payment_gateway.subcomponents.rules.protected.commands.transaction_rules.deactivate_all_card_transaction_rules][]
shared.services.payment_providers.adyen.adyen_webhooks.AdyenWebhooks
shared.services.payment_providers.adyen.clients.adyen_account_holders_api_client.AdyenAccountHoldersApiClient
shared.services.payment_providers.adyen.clients.adyen_balance_accounts_api_client.AdyenBalanceAccountsApiClient
shared.services.payment_providers.adyen.clients.adyen_hosted_onboarding_api_client.AdyenHostedOnboardingApiClient
shared.services.payment_providers.adyen.clients.adyen_legal_entities_api_client.AdyenLegalEntitiesApiClient
shared.services.payment_providers.adyen.clients.adyen_payment_instrument_groups_api_client.AdyenPaymentInstrumentGroupsApiClient
shared.services.payment_providers.adyen.clients.adyen_payment_instrument_reveal_api_client.AdyenPaymentInstrumentRevealApiClient
shared.services.payment_providers.adyen.clients.adyen_payment_instruments_api_client.AdyenPaymentInstrumentsApiClient
shared.services.payment_providers.adyen.clients.adyen_payments_api_client.AdyenPaymentsApiClient
shared.services.payment_providers.adyen.clients.adyen_transaction_rules_api_client.AdyenTransactionRulesApiClient
shared.services.payment_providers.adyen.clients.adyen_transfer_instruments_api_client.AdyenTransferInstrumentsApiClient

payment_flow (12 occurrences)¶

[components.ca.internal.claim_management.claim_engine.steps.reimbursement_payment.business_logic.actions.submit_reimbursement_payment.submit_reimbursement_payment][]
[components.ca.internal.claim_management.claim_engine.steps.settlement.business_logic.actions.reprocess_settlement.reprocess_settlement_payments][]
[components.ca.internal.claim_management.commands.claim_management.retry_payment][]
[components.fr.internal.claim_management.commands.payments.submit_approved_payments][]
[components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.approve_and_submit_payment][]
[components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_approved_payments][]
[components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_reimbursement_payment_review_decision_validation][]
[components.fr.internal.claim_management.internal.services.payment_providers.api.initiate_payout_bank_transfer][]
components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions
components.payment_gateway.subcomponents.payments.protected.business_logic.bank_transfers.BankTransferLogic
[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit][]
[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut][]

revolut (1 occurrence)¶

[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut][]

Tags by Category¶

Value: account_holders_api¶

adyen¶

[components.es.subcomponents.healthy_benefits.internal.business_logic.create_company_balance_account.create_company_balance_account][] - account_holders_api
shared.services.payment_providers.adyen.clients.adyen_account_holders_api_client.AdyenAccountHoldersApiClient - account_holders_api

Value: authorisation_webhooks¶

adyen¶

[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenAuthorisationWebhookController][] - authorisation_webhooks

Value: balance_accounts_api¶

adyen¶

components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_actions.AccountActions - balance_accounts_api
shared.services.payment_providers.adyen.clients.adyen_balance_accounts_api_client.AdyenBalanceAccountsApiClient - balance_accounts_api

Value: business_api¶

revolut¶

[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut][] - business_api

Value: card_order_webhooks¶

adyen¶

[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenCardOrderWebhookController][] - card_order_webhooks

Value: configuration_webhooks¶

adyen¶

[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenConfigurationWebhookController][] - configuration_webhooks

Value: hosted_onboarding_api¶

adyen¶

[components.es.internal.controllers.company.CompanyAdyenOnboardingController.get][] - hosted_onboarding_api
shared.services.payment_providers.adyen.clients.adyen_hosted_onboarding_api_client.AdyenHostedOnboardingApiClient - hosted_onboarding_api

Value: legal_entities_api¶

adyen¶

[components.payment_gateway.public.onboard_legal_entity.onboard_legal_entity][] - legal_entities_api
components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_holder_actions.AccountHolderActions - legal_entities_api
shared.services.payment_providers.adyen.clients.adyen_legal_entities_api_client.AdyenLegalEntitiesApiClient - legal_entities_api

Value: payment_instrument_groups_api¶

adyen¶

shared.services.payment_providers.adyen.clients.adyen_payment_instrument_groups_api_client.AdyenPaymentInstrumentGroupsApiClient - payment_instrument_groups_api

Value: payment_instrument_reveal_api¶

adyen¶

components.payment_gateway.subcomponents.cards.business_logic.queries.card_reveal_queries.CardRevealQueries - payment_instrument_reveal_api
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pan][] - payment_instrument_reveal_api
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pin][] - payment_instrument_reveal_api
shared.services.payment_providers.adyen.clients.adyen_payment_instrument_reveal_api_client.AdyenPaymentInstrumentRevealApiClient - payment_instrument_reveal_api

Value: payment_instruments_api¶

adyen¶

components.payment_gateway.subcomponents.cards.business_logic.actions.card_authentication_actions.CardAuthenticationActions - payment_instruments_api
components.payment_gateway.subcomponents.cards.business_logic.actions.card_incidents_actions.CardIncidentsActions - payment_instruments_api
components.payment_gateway.subcomponents.cards.business_logic.actions.card_lifecycle_actions.CardLifecycleActions - payment_instruments_api
components.payment_gateway.subcomponents.cards.business_logic.actions.card_status_actions.CardStatusActions - payment_instruments_api
[components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_card][] - payment_instruments_api
shared.services.payment_providers.adyen.clients.adyen_payment_instruments_api_client.AdyenPaymentInstrumentsApiClient - payment_instruments_api

Value: payments_api¶

adyen¶

[components.payment_gateway.subcomponents.cards.protected.commands.adyen.payments.simulate_payment][] - payments_api
components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions - payments_api
[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit][] - payments_api
shared.services.payment_providers.adyen.clients.adyen_payments_api_client.AdyenPaymentsApiClient - payments_api

Value: payout¶

payment_flow¶

[components.ca.internal.claim_management.claim_engine.steps.reimbursement_payment.business_logic.actions.submit_reimbursement_payment.submit_reimbursement_payment][] - payout
[components.ca.internal.claim_management.claim_engine.steps.settlement.business_logic.actions.reprocess_settlement.reprocess_settlement_payments][] - payout
[components.ca.internal.claim_management.commands.claim_management.retry_payment][] - payout
[components.fr.internal.claim_management.commands.payments.submit_approved_payments][] - payout
[components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.approve_and_submit_payment][] - payout
[components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_approved_payments][] - payout
[components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_reimbursement_payment_review_decision_validation][] - payout
[components.fr.internal.claim_management.internal.services.payment_providers.api.initiate_payout_bank_transfer][] - payout
components.payment_gateway.subcomponents.payments.protected.business_logic.bank_transfers.BankTransferLogic - payout
[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut][] - payout

Value: topup¶

payment_flow¶

components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions - topup
[components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit][] - topup

Value: transaction_rules_api¶

adyen¶

components.payment_gateway.subcomponents.rules.business_logic.actions.expense_limit_rule_actions.ExpenseLimitRuleActions - transaction_rules_api
components.payment_gateway.subcomponents.rules.business_logic.actions.usage_restriction_rule_actions.UsageRestrictionRuleActions - transaction_rules_api
[components.payment_gateway.subcomponents.rules.protected.commands.transaction_rules.deactivate_all_card_transaction_rules][] - transaction_rules_api
shared.services.payment_providers.adyen.clients.adyen_transaction_rules_api_client.AdyenTransactionRulesApiClient - transaction_rules_api

Value: transfer_instruments_api¶

adyen¶

shared.services.payment_providers.adyen.clients.adyen_transfer_instruments_api_client.AdyenTransferInstrumentsApiClient - transfer_instruments_api

Value: transfer_webhooks¶

adyen¶

[components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenTransferWebhookController][] - transfer_webhooks

Value: webhooks¶

adyen¶

shared.services.payment_providers.adyen.adyen_webhooks.AdyenWebhooks - webhooks

Search for Specific Tags¶

Use {{ tag_search("tag_name") }} to find all objects with a specific tag.

Advanced Usage¶

Individual Macros¶

You can also use the individual tag macros separately:

List All Tags¶

## All Custom Tags

### <span class='md-tag'>adyen</span> (34 occurrences)

- <autoref identifier="components.es.internal.controllers.company.CompanyAdyenOnboardingController.get">components.es.internal.controllers.company.CompanyAdyenOnboardingController.get</autoref>
- <autoref identifier="components.es.subcomponents.healthy_benefits.internal.business_logic.create_company_balance_account.create_company_balance_account">components.es.subcomponents.healthy_benefits.internal.business_logic.create_company_balance_account.create_company_balance_account</autoref>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenAuthorisationWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenAuthorisationWebhookController</autoref>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenCardOrderWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenCardOrderWebhookController</autoref>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenConfigurationWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenConfigurationWebhookController</autoref>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenTransferWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenTransferWebhookController</autoref>
- <autoref identifier="components.payment_gateway.public.onboard_legal_entity.onboard_legal_entity">components.payment_gateway.public.onboard_legal_entity.onboard_legal_entity</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_actions.AccountActions">components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_actions.AccountActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_holder_actions.AccountHolderActions">components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_holder_actions.AccountHolderActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_authentication_actions.CardAuthenticationActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_authentication_actions.CardAuthenticationActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_incidents_actions.CardIncidentsActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_incidents_actions.CardIncidentsActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_lifecycle_actions.CardLifecycleActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_lifecycle_actions.CardLifecycleActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_status_actions.CardStatusActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_status_actions.CardStatusActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.queries.card_reveal_queries.CardRevealQueries">components.payment_gateway.subcomponents.cards.business_logic.queries.card_reveal_queries.CardRevealQueries</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_card">components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_card</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pan">components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pan</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pin">components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pin</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.payments.simulate_payment">components.payment_gateway.subcomponents.cards.protected.commands.adyen.payments.simulate_payment</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions">components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.rules.business_logic.actions.expense_limit_rule_actions.ExpenseLimitRuleActions">components.payment_gateway.subcomponents.rules.business_logic.actions.expense_limit_rule_actions.ExpenseLimitRuleActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.rules.business_logic.actions.usage_restriction_rule_actions.UsageRestrictionRuleActions">components.payment_gateway.subcomponents.rules.business_logic.actions.usage_restriction_rule_actions.UsageRestrictionRuleActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.rules.protected.commands.transaction_rules.deactivate_all_card_transaction_rules">components.payment_gateway.subcomponents.rules.protected.commands.transaction_rules.deactivate_all_card_transaction_rules</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.adyen_webhooks.AdyenWebhooks">shared.services.payment_providers.adyen.adyen_webhooks.AdyenWebhooks</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_account_holders_api_client.AdyenAccountHoldersApiClient">shared.services.payment_providers.adyen.clients.adyen_account_holders_api_client.AdyenAccountHoldersApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_balance_accounts_api_client.AdyenBalanceAccountsApiClient">shared.services.payment_providers.adyen.clients.adyen_balance_accounts_api_client.AdyenBalanceAccountsApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_hosted_onboarding_api_client.AdyenHostedOnboardingApiClient">shared.services.payment_providers.adyen.clients.adyen_hosted_onboarding_api_client.AdyenHostedOnboardingApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_legal_entities_api_client.AdyenLegalEntitiesApiClient">shared.services.payment_providers.adyen.clients.adyen_legal_entities_api_client.AdyenLegalEntitiesApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payment_instrument_groups_api_client.AdyenPaymentInstrumentGroupsApiClient">shared.services.payment_providers.adyen.clients.adyen_payment_instrument_groups_api_client.AdyenPaymentInstrumentGroupsApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payment_instrument_reveal_api_client.AdyenPaymentInstrumentRevealApiClient">shared.services.payment_providers.adyen.clients.adyen_payment_instrument_reveal_api_client.AdyenPaymentInstrumentRevealApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payment_instruments_api_client.AdyenPaymentInstrumentsApiClient">shared.services.payment_providers.adyen.clients.adyen_payment_instruments_api_client.AdyenPaymentInstrumentsApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payments_api_client.AdyenPaymentsApiClient">shared.services.payment_providers.adyen.clients.adyen_payments_api_client.AdyenPaymentsApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_transaction_rules_api_client.AdyenTransactionRulesApiClient">shared.services.payment_providers.adyen.clients.adyen_transaction_rules_api_client.AdyenTransactionRulesApiClient</autoref>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_transfer_instruments_api_client.AdyenTransferInstrumentsApiClient">shared.services.payment_providers.adyen.clients.adyen_transfer_instruments_api_client.AdyenTransferInstrumentsApiClient</autoref>

### <span class='md-tag'>payment_flow</span> (12 occurrences)

- <autoref identifier="components.ca.internal.claim_management.claim_engine.steps.reimbursement_payment.business_logic.actions.submit_reimbursement_payment.submit_reimbursement_payment">components.ca.internal.claim_management.claim_engine.steps.reimbursement_payment.business_logic.actions.submit_reimbursement_payment.submit_reimbursement_payment</autoref>
- <autoref identifier="components.ca.internal.claim_management.claim_engine.steps.settlement.business_logic.actions.reprocess_settlement.reprocess_settlement_payments">components.ca.internal.claim_management.claim_engine.steps.settlement.business_logic.actions.reprocess_settlement.reprocess_settlement_payments</autoref>
- <autoref identifier="components.ca.internal.claim_management.commands.claim_management.retry_payment">components.ca.internal.claim_management.commands.claim_management.retry_payment</autoref>
- <autoref identifier="components.fr.internal.claim_management.commands.payments.submit_approved_payments">components.fr.internal.claim_management.commands.payments.submit_approved_payments</autoref>
- <autoref identifier="components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.approve_and_submit_payment">components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.approve_and_submit_payment</autoref>
- <autoref identifier="components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_approved_payments">components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_approved_payments</autoref>
- <autoref identifier="components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_reimbursement_payment_review_decision_validation">components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_reimbursement_payment_review_decision_validation</autoref>
- <autoref identifier="components.fr.internal.claim_management.internal.services.payment_providers.api.initiate_payout_bank_transfer">components.fr.internal.claim_management.internal.services.payment_providers.api.initiate_payout_bank_transfer</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions">components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.business_logic.bank_transfers.BankTransferLogic">components.payment_gateway.subcomponents.payments.protected.business_logic.bank_transfers.BankTransferLogic</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit</autoref>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut</autoref>

### <span class='md-tag'>revolut</span> (1 occurrence)

- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut</autoref>

Tags by Category¶

## Tags by Category

### Value: account_holders_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.es.subcomponents.healthy_benefits.internal.business_logic.create_company_balance_account.create_company_balance_account">components.es.subcomponents.healthy_benefits.internal.business_logic.create_company_balance_account.create_company_balance_account</autoref> - account_holders_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_account_holders_api_client.AdyenAccountHoldersApiClient">shared.services.payment_providers.adyen.clients.adyen_account_holders_api_client.AdyenAccountHoldersApiClient</autoref> - account_holders_api


### Value: authorisation_webhooks

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenAuthorisationWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenAuthorisationWebhookController</autoref> - authorisation_webhooks


### Value: balance_accounts_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_actions.AccountActions">components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_actions.AccountActions</autoref> - balance_accounts_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_balance_accounts_api_client.AdyenBalanceAccountsApiClient">shared.services.payment_providers.adyen.clients.adyen_balance_accounts_api_client.AdyenBalanceAccountsApiClient</autoref> - balance_accounts_api


### Value: business_api

#### <span class='md-tag'>revolut</span>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut</autoref> - business_api


### Value: card_order_webhooks

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenCardOrderWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenCardOrderWebhookController</autoref> - card_order_webhooks


### Value: configuration_webhooks

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenConfigurationWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenConfigurationWebhookController</autoref> - configuration_webhooks


### Value: hosted_onboarding_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.es.internal.controllers.company.CompanyAdyenOnboardingController.get">components.es.internal.controllers.company.CompanyAdyenOnboardingController.get</autoref> - hosted_onboarding_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_hosted_onboarding_api_client.AdyenHostedOnboardingApiClient">shared.services.payment_providers.adyen.clients.adyen_hosted_onboarding_api_client.AdyenHostedOnboardingApiClient</autoref> - hosted_onboarding_api


### Value: legal_entities_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.payment_gateway.public.onboard_legal_entity.onboard_legal_entity">components.payment_gateway.public.onboard_legal_entity.onboard_legal_entity</autoref> - legal_entities_api
- <autoref identifier="components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_holder_actions.AccountHolderActions">components.payment_gateway.subcomponents.accounts.protected.business_logic.actions.account_holder_actions.AccountHolderActions</autoref> - legal_entities_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_legal_entities_api_client.AdyenLegalEntitiesApiClient">shared.services.payment_providers.adyen.clients.adyen_legal_entities_api_client.AdyenLegalEntitiesApiClient</autoref> - legal_entities_api


### Value: payment_instrument_groups_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payment_instrument_groups_api_client.AdyenPaymentInstrumentGroupsApiClient">shared.services.payment_providers.adyen.clients.adyen_payment_instrument_groups_api_client.AdyenPaymentInstrumentGroupsApiClient</autoref> - payment_instrument_groups_api


### Value: payment_instrument_reveal_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.queries.card_reveal_queries.CardRevealQueries">components.payment_gateway.subcomponents.cards.business_logic.queries.card_reveal_queries.CardRevealQueries</autoref> - payment_instrument_reveal_api
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pan">components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pan</autoref> - payment_instrument_reveal_api
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pin">components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_pin</autoref> - payment_instrument_reveal_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payment_instrument_reveal_api_client.AdyenPaymentInstrumentRevealApiClient">shared.services.payment_providers.adyen.clients.adyen_payment_instrument_reveal_api_client.AdyenPaymentInstrumentRevealApiClient</autoref> - payment_instrument_reveal_api


### Value: payment_instruments_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_authentication_actions.CardAuthenticationActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_authentication_actions.CardAuthenticationActions</autoref> - payment_instruments_api
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_incidents_actions.CardIncidentsActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_incidents_actions.CardIncidentsActions</autoref> - payment_instruments_api
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_lifecycle_actions.CardLifecycleActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_lifecycle_actions.CardLifecycleActions</autoref> - payment_instruments_api
- <autoref identifier="components.payment_gateway.subcomponents.cards.business_logic.actions.card_status_actions.CardStatusActions">components.payment_gateway.subcomponents.cards.business_logic.actions.card_status_actions.CardStatusActions</autoref> - payment_instruments_api
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_card">components.payment_gateway.subcomponents.cards.protected.commands.adyen.cards.reveal_card</autoref> - payment_instruments_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payment_instruments_api_client.AdyenPaymentInstrumentsApiClient">shared.services.payment_providers.adyen.clients.adyen_payment_instruments_api_client.AdyenPaymentInstrumentsApiClient</autoref> - payment_instruments_api


### Value: payments_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.payment_gateway.subcomponents.cards.protected.commands.adyen.payments.simulate_payment">components.payment_gateway.subcomponents.cards.protected.commands.adyen.payments.simulate_payment</autoref> - payments_api
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions">components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions</autoref> - payments_api
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit</autoref> - payments_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_payments_api_client.AdyenPaymentsApiClient">shared.services.payment_providers.adyen.clients.adyen_payments_api_client.AdyenPaymentsApiClient</autoref> - payments_api


### Value: payout

#### <span class='md-tag'>payment_flow</span>
- <autoref identifier="components.ca.internal.claim_management.claim_engine.steps.reimbursement_payment.business_logic.actions.submit_reimbursement_payment.submit_reimbursement_payment">components.ca.internal.claim_management.claim_engine.steps.reimbursement_payment.business_logic.actions.submit_reimbursement_payment.submit_reimbursement_payment</autoref> - payout
- <autoref identifier="components.ca.internal.claim_management.claim_engine.steps.settlement.business_logic.actions.reprocess_settlement.reprocess_settlement_payments">components.ca.internal.claim_management.claim_engine.steps.settlement.business_logic.actions.reprocess_settlement.reprocess_settlement_payments</autoref> - payout
- <autoref identifier="components.ca.internal.claim_management.commands.claim_management.retry_payment">components.ca.internal.claim_management.commands.claim_management.retry_payment</autoref> - payout
- <autoref identifier="components.fr.internal.claim_management.commands.payments.submit_approved_payments">components.fr.internal.claim_management.commands.payments.submit_approved_payments</autoref> - payout
- <autoref identifier="components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.approve_and_submit_payment">components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.approve_and_submit_payment</autoref> - payout
- <autoref identifier="components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_approved_payments">components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_approved_payments</autoref> - payout
- <autoref identifier="components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_reimbursement_payment_review_decision_validation">components.fr.internal.claim_management.internal.misc.business_logic.reimbursement_payment.submit_reimbursement_payment_review_decision_validation</autoref> - payout
- <autoref identifier="components.fr.internal.claim_management.internal.services.payment_providers.api.initiate_payout_bank_transfer">components.fr.internal.claim_management.internal.services.payment_providers.api.initiate_payout_bank_transfer</autoref> - payout
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.business_logic.bank_transfers.BankTransferLogic">components.payment_gateway.subcomponents.payments.protected.business_logic.bank_transfers.BankTransferLogic</autoref> - payout
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_payout_with_revolut</autoref> - payout


### Value: topup

#### <span class='md-tag'>payment_flow</span>
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions">components.payment_gateway.subcomponents.payments.protected.business_logic.actions.bank_transfer_actions.BankTransferActions</autoref> - topup
- <autoref identifier="components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit">components.payment_gateway.subcomponents.payments.protected.commands.payment_request.simulate_direct_debit</autoref> - topup


### Value: transaction_rules_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.payment_gateway.subcomponents.rules.business_logic.actions.expense_limit_rule_actions.ExpenseLimitRuleActions">components.payment_gateway.subcomponents.rules.business_logic.actions.expense_limit_rule_actions.ExpenseLimitRuleActions</autoref> - transaction_rules_api
- <autoref identifier="components.payment_gateway.subcomponents.rules.business_logic.actions.usage_restriction_rule_actions.UsageRestrictionRuleActions">components.payment_gateway.subcomponents.rules.business_logic.actions.usage_restriction_rule_actions.UsageRestrictionRuleActions</autoref> - transaction_rules_api
- <autoref identifier="components.payment_gateway.subcomponents.rules.protected.commands.transaction_rules.deactivate_all_card_transaction_rules">components.payment_gateway.subcomponents.rules.protected.commands.transaction_rules.deactivate_all_card_transaction_rules</autoref> - transaction_rules_api
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_transaction_rules_api_client.AdyenTransactionRulesApiClient">shared.services.payment_providers.adyen.clients.adyen_transaction_rules_api_client.AdyenTransactionRulesApiClient</autoref> - transaction_rules_api


### Value: transfer_instruments_api

#### <span class='md-tag'>adyen</span>
- <autoref identifier="shared.services.payment_providers.adyen.clients.adyen_transfer_instruments_api_client.AdyenTransferInstrumentsApiClient">shared.services.payment_providers.adyen.clients.adyen_transfer_instruments_api_client.AdyenTransferInstrumentsApiClient</autoref> - transfer_instruments_api


### Value: transfer_webhooks

#### <span class='md-tag'>adyen</span>
- <autoref identifier="components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenTransferWebhookController">components.es.subcomponents.healthy_benefits.protected.controllers.adyen_webhooks.AdyenTransferWebhookController</autoref> - transfer_webhooks


### Value: webhooks

#### <span class='md-tag'>adyen</span>
- <autoref identifier="shared.services.payment_providers.adyen.adyen_webhooks.AdyenWebhooks">shared.services.payment_providers.adyen.adyen_webhooks.AdyenWebhooks</autoref> - webhooks

Search for Specific Tag¶

_No objects found with tag `api`._

How to Add Tags to Your Code¶

Add a Tags: section to your docstrings and provide each tag as a list item:

def my_function():
    """Function description.

    Tags:
        - @api: public
        - @deprecated: true
        - @security: authentication
        - @performance
    """
    pass

The following tag formats are supported:

@tag - Boolean tag with @ prefix
@tag: value - Tag with @ prefix and value separated by a colon