feat(business_profile): add business_profile config to enable external vault

[Sakilmostak]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

Description

• add fields in business profile to collect external vault connector details i.e. is_externa_vault_enabled, external_vault_connector_details
• is_external_vault_enabled is a boolean value that decide if external vault is enabled for the given profile
• external_vault_connector_details collects the vault_connector_id for the external vault where the data will be saved
• these fields are added in both create and update call for business_profile

Additional Changes

• This PR modifies the API contract
  add a new field in request of /v2/profiles i.e vault_connector_details which is an nullable object that takes 3 fields

    "is_external_vault_enabled": true,
    "vault_connector_details": {
        "vault_connector_id": "connector_id",
    }

• This PR modifies the database schema

add two new column to business_profile table i.e, vault_connector_details and is_external_vault_enabled

• This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Tested through postman:

• for a merchant, create a business_profile with external vault enabled:

curl --location '{{base_url}}/v2/profiles' \
--header 'x-merchant-id: {{merchant_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: admin-api-key={{api_key}}' \
--data-raw '{
    "profile_name": "business",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "redirect_to_merchant_with_http_post": false,
    "webhook_details": {
        "webhook_version": "1.0.1",
        "webhook_username": "ekart_retail",
        "webhook_password": "password_ekart@123",
        "webhook_url": "https://webhook.site",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true
    },
    "metadata": null,
    "order_fulfillment_time": 900,
    "order_fulfillment_time_origin": "create",
    "applepay_verified_domains": null,
    "session_expiry": 900,
    "payment_link_config": null,
    "authentication_connector_details": null,
    "use_billing_as_payment_method_billing": true,
    "collect_shipping_details_from_wallet_connector_if_required": false,
    "collect_billing_details_from_wallet_connector_if_required": false,
    "always_collect_shipping_details_from_wallet_connector": false,
    "always_collect_billing_details_from_wallet_connector": false,
    "is_connector_agnostic_mit_enabled": false,
    "payout_link_config": null,
    "outgoing_webhook_custom_http_headers": null,
    "is_network_tokenization_enabled": false
    "is_external_vault_enabled": true,
    "external_vault_connector_details": {
        "vault_connector_id": "connector_id"
    }
}'

• update the business profile with external_vault data:

curl --location --request PUT '{{base_url}}/v2/profiles/{{profile_id}}' \
--header 'x-merchant-id: {{merchant_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: admin-api-key={{api_key}}' \
--data-raw '{
    "is_external_vault_enabled": true,
    "vault_connector_details": {
        "vault_connector_id": "connector_id"
    }
}'

Checklist

• I formatted the code cargo +nightly fmt --all
• I addressed lints thrown by cargo clippy
• I reviewed the submitted code
• I added unit tests for my changes where possible

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
crates/openapi/src/openapi_v2.rs	10% smaller
api-reference-v2/openapi_spec.json	0% smaller
crates/api_models/src/admin.rs	0% smaller
crates/diesel_models/src/business_profile.rs	0% smaller
crates/diesel_models/src/schema_v2.rs	0% smaller
crates/hyperswitch_domain_models/src/business_profile.rs	0% smaller
crates/router/src/core/admin.rs	0% smaller
crates/router/src/types/api/admin.rs	0% smaller
crates/router/src/types/transformers.rs	0% smaller
v2_compatible_migrations/2025-04-28-095013_add-is_external_vault_enabled-and-vault_connector_details-column-to-business_profile-table/down.sql	Unsupported file format
v2_compatible_migrations/2025-04-28-095013_add-is_external_vault_enabled-and-vault_connector_details-column-to-business_profile-table/up.sql	Unsupported file format

[jarnura]

instead adding in default, handle this in code itself, basically null is false

[Sakilmostak]

In the subsequent PR #7917 where this field is being used, the logic have been added to handle null cases as well👍

pub fn get_is_external_vault_enabled(&self) -> bool {
        self.is_external_vault_enabled.unwrap_or(false)
    }

[su-shivanshmathur]

Lgtm