feat(business_profile): add business_profile config to enable external vault by Sakilmostak · Pull Request #7876 · juspay/hyperswitch

Sakilmostak · 2025-04-23T07:23:58Z

Type of Change

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 · 2025-04-23T07:24:01Z

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

crates/common_enums/src/enums.rs

crates/api_models/src/admin.rs

jarnura · 2025-05-06T14:31:46Z

...s_external_vault_enabled-and-vault_connector_details-column-to-business_profile-table/up.sql

@@ -0,0 +1,6 @@
+-- Your SQL goes here
+ALTER TABLE business_profile
+ADD COLUMN IF NOT EXISTS is_external_vault_enabled BOOLEAN DEFAULT FALSE;


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

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

…adyen-ideal * 'main' of github.com:juspay/hyperswitch: (62 commits) fix(core): language consumption from locale in payment and payout links (#7993) feat(refunds_v2): Add refunds list flow in v2 apis (#7966) refactor(connector): [Noon] auth header (#7977) fix(connector): [Novalnet] send decoded token for apple pay payment (#7973) feat(business_profile): add business_profile config to enable external vault (#7876) feat(vsaas): integrate onboarding flow for vertical saas (#7884) feat(connector): Introduce connector template code for WorldpayXML (#7968) feat(connector): [ADYEN, CHECKOUT] Added In Feature Matrix API (#7914) feat(core): add psync support for recovery external payments (#7855) refactor(open_router): call elimination routing of open router if enabled instead of dynamo (#7961) feat(payment_methods): add v2 api for fetching token data (#7629) ci(cypress): Fix Bank Redirects for stripe test (#8004) chore(version): 2025.05.12.0 refactor(authentication): moved cavv storing from table to temp locker (#7978) chore(version): 2025.05.09.0 feat(connector): [paypal, trustpay] add in feature matrix (#7911) fix(update_metadata): Update Metadata for any connectors other than stripe gives 500 error (#7984) fix(router): Fixed stack over flow for session call in authentication connectors (#7983) chore(version): 2025.05.08.0 fix(payment): disable payment update via client config (#7970) ...

feat: add business_profile config to enable external vault

8829eed

Sakilmostak added C-feature Category: Feature request or enhancement A-payment-methods Area: Payment Methods labels Apr 23, 2025

Sakilmostak self-assigned this Apr 23, 2025

hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Apr 23, 2025

refactor: resolve ci checks

4b4055c

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Apr 23, 2025

refactor: add connector_id and sdk for vault config in business_profile

30c70cb

Sakilmostak changed the title ~~draft: add business_profile config to enable external vault~~ feat(business_profile): add business_profile config to enable external vault Apr 23, 2025

Sakilmostak marked this pull request as ready for review April 23, 2025 16:46

Sakilmostak requested review from a team as code owners April 23, 2025 16:46

refactor: remove vault connector name from connector_details

0cdb56e

Narayanbhat166 reviewed Apr 24, 2025

View reviewed changes

crates/common_enums/src/enums.rs Outdated Show resolved Hide resolved

Sakilmostak added 5 commits April 24, 2025 16:43

refactor: change api contract for config

051526c

refactor: remove unused enum

255ce91

Merge branch 'main' into external_vault_flow

7460599

refactor: resolve conflict with main

0087037

refactor: resolve migration check

7da0fb5

prasunna09 reviewed Apr 30, 2025

View reviewed changes

crates/api_models/src/admin.rs Outdated Show resolved Hide resolved

crates/api_models/src/admin.rs Outdated Show resolved Hide resolved

crates/api_models/src/admin.rs Outdated Show resolved Hide resolved

Sakilmostak added 2 commits May 5, 2025 15:50

Merge branch 'main' into external_vault_flow

f1cda9d

refactor: resolve comments

7fe67be

prasunna09 previously approved these changes May 6, 2025

View reviewed changes

jarnura requested changes May 6, 2025

View reviewed changes

refactor: resolve comment

e3bcbc6

Sakilmostak dismissed prasunna09’s stale review via e3bcbc6 May 6, 2025 18:50

jarnura approved these changes May 7, 2025

View reviewed changes

su-shivanshmathur approved these changes May 7, 2025

View reviewed changes

Gnanasundari24 added this pull request to the merge queue May 12, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 12, 2025

Gnanasundari24 added this pull request to the merge queue May 12, 2025

Merged via the queue into main with commit 8cb5bfc May 12, 2025
16 of 20 checks passed

Gnanasundari24 deleted the external_vault_flow branch May 12, 2025 15:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

feat(business_profile): add business_profile config to enable external vault#7876
Gnanasundari24 merged 12 commits intomainfrom
external_vault_flow

Sakilmostak commented Apr 23, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Apr 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jarnura May 6, 2025

Uh oh!

Sakilmostak May 6, 2025

Uh oh!

su-shivanshmathur left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

Sakilmostak commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jarnura May 6, 2025

Choose a reason for hiding this comment

Uh oh!

Sakilmostak May 6, 2025

Choose a reason for hiding this comment

Uh oh!

su-shivanshmathur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Sakilmostak commented Apr 23, 2025 •

edited

Loading

semanticdiff-com bot commented Apr 23, 2025 •

edited

Loading