feat(router): Add support for storing multiple surcharge configurations at profile level #7570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 9 commits
March 5, 2025 15:10
…vel endpoint to list all surcharge configs
…ti-surcharge-configs
spritianeja03
added
C-feature
hyperswitch-bot
bot
removed
the
M-api-contract-changes
hyperswitch-bot
bot
added
the
M-api-contract-changes
| ToSchema, | ||
| Default, | ||
| )] | ||
| #[router_derive::diesel_enum(storage_type = "db_enum")] |
There was a problem hiding this comment.
Suggested change
| #[router_derive::diesel_enum(storage_type = "db_enum")] | |
| #[router_derive::diesel_enum(storage_type = "text")] |
Making this db_enum would make it difficult to add new enum variant in future.
| /// A wrapper type for `RoutingId` that can be used for surcharge routing ids | ||
| pub struct SurchargeRoutingId(pub RoutingId); | ||
|
|
||
| impl Deref for SurchargeRoutingId { |
Comment on lines
+1059
to
+1062
| ) | ||
| .service( | ||
| web::resource("/{algorithm_id}/surcharge/activate") | ||
| .route(web::post().to(routing::surcharge_link_config)), |
There was a problem hiding this comment.
Suggested change
| ) | |
| .service( | |
| web::resource("/{algorithm_id}/surcharge/activate") | |
| .route(web::post().to(routing::surcharge_link_config)), | |
| ) | |
| .service( | |
| web::resource("decision/surcharge/{algorithm_id}/activate") | |
| .route(web::post().to(routing::surcharge_link_config)), |
| req, | ||
| payload, | ||
| &TransactionType::Payment, | ||
| AlgorithmType::Surcharge, |
There was a problem hiding this comment.
create a const for this and pass to this function.
| @@ -0,0 +1,4 @@ | |||
| -- Your SQL goes here | |||
| CREATE TYPE "AlgorithmType" AS ENUM ('routing', 'surcharge', '3ds'); | |||
There was a problem hiding this comment.
lets not create a DB enum right now.
| -- Your SQL goes here | ||
| CREATE TYPE "AlgorithmType" AS ENUM ('routing', 'surcharge', '3ds'); | ||
|
|
||
| ALTER TABLE routing_algorithm ADD COLUMN IF NOT EXISTS algorithm_type "AlgorithmType" NOT NULL; |
There was a problem hiding this comment.
Suggested change
| ALTER TABLE routing_algorithm ADD COLUMN IF NOT EXISTS algorithm_type "AlgorithmType" NOT NULL; | |
| ALTER TABLE routing_algorithm ADD COLUMN IF NOT EXISTS algorithm_type VARCHAR(64) NOT NULL; |
Comment on lines
+240
to
+246
| let profile_id = profile_id | ||
| .ok_or_else(|| errors::ApiErrorResponse::MissingRequiredField { | ||
| field_name: "profile_id", | ||
| }) | ||
| .change_context(errors::ApiErrorResponse::MissingRequiredField { | ||
| field_name: "profile_id", | ||
| })?; |
There was a problem hiding this comment.
Lets do this validation in the parent function get profile_id as non optional value int this function.
Comment on lines
+307
to
+313
| let profile_id = profile_id | ||
| .ok_or_else(|| errors::ApiErrorResponse::MissingRequiredField { | ||
| field_name: "profile_id", | ||
| }) | ||
| .change_context(errors::ApiErrorResponse::MissingRequiredField { | ||
| field_name: "profile_id", | ||
| })?; |
There was a problem hiding this comment.
Lets do this validation in the parent function get profile_id as non optional value int this function.
Comment on lines
+280
to
+303
| let name = request | ||
| .name | ||
| .get_required_value("name") | ||
| .change_context(errors::ApiErrorResponse::MissingRequiredField { field_name: "name" }) | ||
| .attach_printable("Name of config not given")?; | ||
|
|
||
| let description = request | ||
| .description | ||
| .get_required_value("description") | ||
| .change_context(errors::ApiErrorResponse::MissingRequiredField { | ||
| field_name: "description", | ||
| }) | ||
| .attach_printable("Description of config not given")?; | ||
|
|
||
| let surcharge_algorithm_data = SurchargeDecisionManagerConfig { | ||
| merchant_surcharge_configs: request.merchant_surcharge_configs.clone(), | ||
| algorithm: request | ||
| .algorithm | ||
| .get_required_value("algorithm") | ||
| .change_context(errors::ApiErrorResponse::MissingRequiredField { | ||
| field_name: "algorithm", | ||
| }) | ||
| .attach_printable("Algorithm of config not given")?, | ||
| }; |
There was a problem hiding this comment.
introduce a new request type where are these values will be required.
| .await | ||
| .to_not_found_response(errors::ApiErrorResponse::ResourceIdNotFound)?; | ||
|
|
||
| let new_record = SurchargeRecord { |
There was a problem hiding this comment.
return description as well
| let profile_id = query.profile_id; | ||
|
|
||
| let final_response; | ||
| if let Some(profile_id) = profile_id.clone() { |
There was a problem hiding this comment.
profile_id can be amde required in SurchargeRetrieveLinkQuery
Comment on lines
+411
to
+413
| return Err(errors::ApiErrorResponse::ResourceIdNotFound) | ||
| .change_context(errors::ApiErrorResponse::ResourceIdNotFound) | ||
| .attach_printable("Active surcharge algorithm ID not found"); |
There was a problem hiding this comment.
Suggested change
| return Err(errors::ApiErrorResponse::ResourceIdNotFound) | |
| .change_context(errors::ApiErrorResponse::ResourceIdNotFound) | |
| .attach_printable("Active surcharge algorithm ID not found"); | |
| return report!(errors::ApiErrorResponse::ResourceIdNotFound) | |
| .attach_printable("Active surcharge algorithm ID not found"); |
| state: SessionState, | ||
| merchant_account: domain::MerchantAccount, | ||
| key_store: domain::MerchantKeyStore, | ||
| auth_profile_id: Option<id_type::ProfileId>, |
There was a problem hiding this comment.
Suggested change
| auth_profile_id: Option<id_type::ProfileId>, | |
| auth_profile_id: id_type::ProfileId, |
| merchant_account: domain::MerchantAccount, | ||
| key_store: domain::MerchantKeyStore, | ||
| auth_profile_id: Option<id_type::ProfileId>, | ||
| algorithm_id: id_type::RoutingId, |
There was a problem hiding this comment.
Suggested change
| algorithm_id: id_type::RoutingId, | |
| algorithm_id: id_type::SurchargeRoutingId, |
| active_surcharge_algorithm_id: Some(surcharge_algorithm_id), | ||
| }; | ||
|
|
||
| db.update_profile_by_profile_id( |
There was a problem hiding this comment.
Suggested change
| db.update_profile_by_profile_id( | |
| let updated_profile = db.update_profile_by_profile_id( |
Comment on lines
+475
to
+478
| let updated_profile = db | ||
| .find_business_profile_by_profile_id(key_manager_state, &key_store, &profile_id) | ||
| .await | ||
| .to_not_found_response(errors::ApiErrorResponse::ResourceIdNotFound)?; |
There was a problem hiding this comment.
Suggested change
| let updated_profile = db | |
| .find_business_profile_by_profile_id(key_manager_state, &key_store, &profile_id) | |
| .await | |
| .to_not_found_response(errors::ApiErrorResponse::ResourceIdNotFound)?; |
Comment on lines
+484
to
+487
| let record = db | ||
| .find_routing_algorithm_by_profile_id_algorithm_id(&profile_id, &active_algorithm_id) | ||
| .await | ||
| .to_not_found_response(errors::ApiErrorResponse::ResourceIdNotFound)?; |
There was a problem hiding this comment.
should do this validation before updating business_profile.
steps
- validate business_profile_id
- validate surcharge_routing_id
- update business profile with active surcharge id.
| @@ -120,6 +120,7 @@ impl RoutingAlgorithmUpdate { | |||
| created_at: timestamp, | |||
| modified_at: timestamp, | |||
| algorithm_for: transaction_type, | |||
| algorithm_type: enums::AlgorithmType::Routing, | |||
There was a problem hiding this comment.
use const wherever this is hardcoded.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Change
Description
This PR adds support for storing multiple surcharge configurations at profile level by adding new endpoints to list, create, activate and retrieve active surcharge configurations.
Additional Changes
Motivation and Context
Closes #7569
How did you test it?
Checklist
cargo +nightly fmt --allcargo clippy