feat(core): implemented platform merchant account #6882

racnan · 2024-12-18T18:20:15Z

Type of Change

Description

About the feature

This the first PR for the Platform Account feature.
Feature is under development and behind the feature flag.
Feature is supposed to be disabled for sandbox and production environments.

Enabling the platform account.

New API has been created to enable platform account.
API requires Admin API auth.
Once enabled, there is no way of disabling platform account as of now.

How it works

A new special header is to be sent by the platform called x-connected-merchant-id.
Platform will use its own API key irrespective of the merchant id present in the above header.
Value of this header is supposed to be the merchant id of the merchant account on behalf of which the platform is performing the operation.
If the platform has is_platform true and the merchant account on behalf of which operation is performed belongs to the same organisation as platform then the operation is allowed.

Payment Intent

Operation will be performed for merchant id present in the x-connected-merchant-id header.
platform_merchant_id column for the payment intent will be populated with platforms merchant id.

Other operations

Will add context of platform_merchant_id in other operations as well.

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

#6883

How did you test it?

Create a merchant account(m1).
Use below api to convert it into platform account.

curl --location --request POST '<BASE URL>/accounts/{merchant_id}/platform' \
--header 'api-key:<ADMIN API KEY>'

Create another merchant account in the same organisation(m2).
Do a payment using platform's(m1) API key for connected merchant account(m2) by passing header x-connected-merchant-id with value as connected merchant account's merchant id.
Check if payment is created for connected merchant account.
Check if platform_merchant_id is populated with platform's merchant 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 · 2024-12-18T18:20:18Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/lock_utils.rs	86% smaller
crates/router/build.rs	66% smaller
crates/router/src/routes/app.rs	16% smaller
crates/router/src/compatibility/stripe/errors.rs	6% smaller
crates/router/src/services/authentication.rs	3% smaller
.github/workflows/postman-collection-runner.yml	Unsupported file format
config/deployments/integration_test.toml	Unsupported file format
config/deployments/production.toml	Unsupported file format
config/deployments/sandbox.toml	Unsupported file format
config/development.toml	Unsupported file format
config/docker_compose.toml	Unsupported file format
crates/diesel_models/src/merchant_account.rs	0% smaller
crates/diesel_models/src/payment_intent.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
crates/diesel_models/src/schema_v2.rs	0% smaller
crates/hyperswitch_domain_models/src/errors/api_error_response.rs	0% smaller
crates/hyperswitch_domain_models/src/merchant_account.rs	0% smaller
crates/hyperswitch_domain_models/src/payments.rs	0% smaller
crates/hyperswitch_domain_models/src/payments/payment_intent.rs	0% smaller
crates/router/src/compatibility/stripe/payment_intents.rs	0% smaller
crates/router/src/compatibility/stripe/setup_intents.rs	0% smaller
crates/router/src/configs/secrets_transformers.rs	0% smaller
crates/router/src/configs/settings.rs	0% smaller
crates/router/src/core/admin.rs	0% smaller
crates/router/src/core/fraud_check.rs	0% smaller
crates/router/src/core/fraud_check/operation.rs	0% smaller
crates/router/src/core/fraud_check/operation/fraud_check_post.rs	0% smaller
crates/router/src/core/payments.rs	0% smaller
crates/router/src/core/payments/helpers.rs	0% smaller
crates/router/src/core/payments/operations.rs	0% smaller
crates/router/src/core/payments/operations/payment_approve.rs	0% smaller
crates/router/src/core/payments/operations/payment_cancel.rs	0% smaller
crates/router/src/core/payments/operations/payment_capture.rs	0% smaller
crates/router/src/core/payments/operations/payment_capture_v2.rs	0% smaller
crates/router/src/core/payments/operations/payment_complete_authorize.rs	0% smaller
crates/router/src/core/payments/operations/payment_confirm.rs	0% smaller
crates/router/src/core/payments/operations/payment_confirm_intent.rs	0% smaller
crates/router/src/core/payments/operations/payment_create.rs	0% smaller
crates/router/src/core/payments/operations/payment_create_intent.rs	0% smaller
crates/router/src/core/payments/operations/payment_get.rs	0% smaller
crates/router/src/core/payments/operations/payment_get_intent.rs	0% smaller
crates/router/src/core/payments/operations/payment_post_session_tokens.rs	0% smaller
crates/router/src/core/payments/operations/payment_reject.rs	0% smaller
crates/router/src/core/payments/operations/payment_session.rs	0% smaller
crates/router/src/core/payments/operations/payment_session_intent.rs	0% smaller
crates/router/src/core/payments/operations/payment_start.rs	0% smaller
crates/router/src/core/payments/operations/payment_status.rs	0% smaller
crates/router/src/core/payments/operations/payment_update.rs	0% smaller
crates/router/src/core/payments/operations/payment_update_intent.rs	0% smaller
crates/router/src/core/payments/operations/payments_incremental_authorization.rs	0% smaller
crates/router/src/core/payments/operations/tax_calculation.rs	0% smaller
crates/router/src/core/payments/session_operation.rs	0% smaller
crates/router/src/core/webhooks/incoming.rs	0% smaller
crates/router/src/lib.rs	0% smaller
crates/router/src/routes/admin.rs	0% smaller
crates/router/src/routes/payments.rs	0% smaller
crates/router/src/utils/user/sample_data.rs	0% smaller
crates/router/src/workflows/outgoing_webhook_retry.rs	0% smaller
crates/router/src/workflows/payment_sync.rs	0% smaller
crates/router/tests/payments.rs	0% smaller
crates/router/tests/payments2.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller
migrations/2024-12-03-072318_platform_merchant_account/down.sql	Unsupported file format
migrations/2024-12-03-072318_platform_merchant_account/up.sql	Unsupported file format

Narayanbhat166 · 2024-12-20T12:57:34Z

crates/router/src/core/payments/operations/payment_confirm.rs

@@ -77,6 +77,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest>
        key_store: &domain::MerchantKeyStore,
        auth_flow: services::AuthFlow,
        header_payload: &hyperswitch_domain_models::payments::HeaderPayload,
+        _platform_merchant_account: Option<&domain::MerchantAccount>,


we should validate that this belongs to the same merchant_id that was passed in create right?

yess, will add validations in eventual PRs.

Narayanbhat166 · 2024-12-20T13:26:29Z

crates/router/src/services/authentication.rs

@@ -548,8 +573,31 @@ where
            .await
            .to_not_found_response(errors::ApiErrorResponse::Unauthorized)?;

+        // Get connected merchant account if API call is done by Platform merchant account on behalf of connected merchant account
+        let (merchant, platform_merchant_account) = if state.conf().platform.enabled {
+            get_platform_merchant_account(state, request_headers, merchant).await?


we can pass key store from this function itself

…ount

pixincreate

configs and ci, look good to me

NishantJoshi00

The HeaderAuth side of things look good

SanchithHegde · 2024-12-23T10:00:43Z

config/deployments/integration_test.toml

Can you make the same changes in the other config files as well: config/development.toml and config/docker_compose.toml?

SanchithHegde · 2024-12-23T10:12:36Z

crates/router/src/services/authentication.rs

@@ -724,12 +775,14 @@ where
 }

 #[cfg(all(feature = "partial-auth", feature = "v1"))]
+#[allow(unused)]


Do we still need this annotation?

SanchithHegde · 2024-12-23T10:13:18Z

crates/router/src/services/authentication.rs

@@ -1412,15 +1537,20 @@ pub struct MerchantIdAuth(pub id_type::MerchantId);

 #[cfg(feature = "v1")]
 #[async_trait]
+#[allow(unused)]


racnan added 18 commits November 13, 2024 23:40

added is_platform_account column

1014f23

added platform authentication functions

14601c0

added non connected flows error

38fe0be

Merge branch 'main' into platform-merchant-account

86c3f77

added platform auth in apikeyauth

0f3fb99

added platform merchant id to payment

5510f70

happy flow fix

5af6299

Merge branch 'main' into platform-merchant-account

ad51351

added invalid platform error

587205e

platform checks in header auth

9915ca0

Merge branch 'main' into platform-merchant-account

ac4b57e

v2 compiles

bbc907c

tests and fmt

cd8b2c6

Merge branch 'main' into platform-merchant-account

312735d

post merge cleanup

a84a4dc

post merge v2 cleanup

01deb60

added route to enable platform account

00a063f

feature flagged

1624383

racnan requested review from a team as code owners December 18, 2024 18:20

racnan self-assigned this Dec 18, 2024

hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Dec 18, 2024

racnan and others added 5 commits December 19, 2024 16:35

Merge branch 'main' into platform-merchant-account

a90500a

env flags

d609bff

Merge branch 'main' into platform-merchant-account

ac68b81

v2 disbaled

1ec1244

restructure getter function

d1f5880

jarnura previously approved these changes Dec 20, 2024

View reviewed changes

Narayanbhat166 reviewed Dec 20, 2024

View reviewed changes

Narayanbhat166 previously approved these changes Dec 20, 2024

View reviewed changes

racnan added 2 commits December 21, 2024 00:43

Merge remote-tracking branch 'origin/main' into platform-merchant-acc…

f11c40e

…ount

Merge branch 'main' into platform-merchant-account

6be65ca

racnan dismissed stale reviews from Narayanbhat166 and jarnura via 6be65ca December 20, 2024 19:19

Narayanbhat166 and others added 2 commits December 21, 2024 09:53

chore: increase min stack size in debug builds to solve postman errors

13fbda2

stack size and v2

7102076

racnan force-pushed the platform-merchant-account branch from a1c7434 to 7102076 Compare December 21, 2024 19:05

racnan added 2 commits December 23, 2024 14:19

min stack to 10mb

009e692

Merge branch 'main' into platform-merchant-account

cccf034

racnan requested a review from a team as a code owner December 23, 2024 08:55

pixincreate previously approved these changes Dec 23, 2024

View reviewed changes

NishantJoshi00 previously approved these changes Dec 23, 2024

View reviewed changes

Narayanbhat166 previously approved these changes Dec 23, 2024

View reviewed changes

SanchithHegde reviewed Dec 23, 2024

View reviewed changes

clean up

724cf37

racnan dismissed stale reviews from Narayanbhat166, NishantJoshi00, and pixincreate via 724cf37 December 23, 2024 10:30

Narayanbhat166 approved these changes Dec 23, 2024

View reviewed changes

SanchithHegde approved these changes Dec 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): implemented platform merchant account #6882

feat(core): implemented platform merchant account #6882

racnan commented Dec 18, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 18, 2024 •

edited

Loading

Narayanbhat166 Dec 20, 2024

racnan Dec 23, 2024

Narayanbhat166 Dec 20, 2024

pixincreate left a comment

NishantJoshi00 left a comment

SanchithHegde Dec 23, 2024 •

edited

Loading

SanchithHegde Dec 23, 2024

SanchithHegde Dec 23, 2024

feat(core): implemented platform merchant account #6882

Are you sure you want to change the base?

feat(core): implemented platform merchant account #6882

Conversation

racnan commented Dec 18, 2024 • edited Loading

Type of Change

Description

About the feature

Enabling the platform account.

How it works

Payment Intent

Other operations

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Dec 18, 2024 • edited Loading

Narayanbhat166 Dec 20, 2024

Choose a reason for hiding this comment

racnan Dec 23, 2024

Choose a reason for hiding this comment

Narayanbhat166 Dec 20, 2024

Choose a reason for hiding this comment

pixincreate left a comment

Choose a reason for hiding this comment

NishantJoshi00 left a comment

Choose a reason for hiding this comment

SanchithHegde Dec 23, 2024 • edited Loading

Choose a reason for hiding this comment

SanchithHegde Dec 23, 2024

Choose a reason for hiding this comment

SanchithHegde Dec 23, 2024

Choose a reason for hiding this comment

racnan commented Dec 18, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 18, 2024 •

edited

Loading

SanchithHegde Dec 23, 2024 •

edited

Loading