feat(payments): [Payment links] add configs for payment link (#7340)

cookieg13 · hyperswitch-bot[bot] · Sakilmostak · commit 075dcce5a955 · 2025-03-03T19:47:26.000+05:30
Co-authored-by: hyperswitch-bot[bot] &lt;148525504+hyperswitch-bot[bot]@users.noreply.github.com&gt;
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
@@ -13862,6 +13862,21 @@
             "type": "string",
             "description": "Custom background colour for payment link's handle confirm button",
             "nullable": true
+          },
+          "skip_status_screen": {
+            "type": "boolean",
+            "description": "Skip the status screen after payment completion",
+            "nullable": true
+          },
+          "payment_button_text_colour": {
+            "type": "string",
+            "description": "Custom text colour for payment link's handle confirm button",
+            "nullable": true
+          },
+          "background_colour": {
+            "type": "string",
+            "description": "Custom background colour for the payment link",
+            "nullable": true
           }
         }
       },
@@ -13962,6 +13977,21 @@
             "type": "string",
             "description": "Custom background colour for payment link's handle confirm button",
             "nullable": true
+          },
+          "skip_status_screen": {
+            "type": "boolean",
+            "description": "Skip the status screen after payment completion",
+            "nullable": true
+          },
+          "payment_button_text_colour": {
+            "type": "string",
+            "description": "Custom text colour for payment link's handle confirm button",
+            "nullable": true
+          },
+          "background_colour": {
+            "type": "string",
+            "description": "Custom background colour for the payment link",
+            "nullable": true
           }
         }
       },
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
@@ -16502,6 +16502,21 @@
             "type": "string",
             "description": "Custom background colour for payment link's handle confirm button",
             "nullable": true
+          },
+          "skip_status_screen": {
+            "type": "boolean",
+            "description": "Skip the status screen after payment completion",
+            "nullable": true
+          },
+          "payment_button_text_colour": {
+            "type": "string",
+            "description": "Custom text colour for payment link's handle confirm button",
+            "nullable": true
+          },
+          "background_colour": {
+            "type": "string",
+            "description": "Custom background colour for the payment link",
+            "nullable": true
           }
         }
       },
@@ -16602,6 +16617,21 @@
             "type": "string",
             "description": "Custom background colour for payment link's handle confirm button",
             "nullable": true
+          },
+          "skip_status_screen": {
+            "type": "boolean",
+            "description": "Skip the status screen after payment completion",
+            "nullable": true
+          },
+          "payment_button_text_colour": {
+            "type": "string",
+            "description": "Custom text colour for payment link's handle confirm button",
+            "nullable": true
+          },
+          "background_colour": {
+            "type": "string",
+            "description": "Custom background colour for the payment link",
+            "nullable": true
           }
         }
       },
diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs
@@ -2786,6 +2786,12 @@ pub struct PaymentLinkConfigRequest {
     pub custom_message_for_card_terms: Option<String>,
     /// Custom background colour for payment link's handle confirm button
     pub payment_button_colour: Option<String>,
+    /// Skip the status screen after payment completion
+    pub skip_status_screen: Option<bool>,
+    /// Custom text colour for payment link's handle confirm button
+    pub payment_button_text_colour: Option<String>,
+    /// Custom background colour for the payment link
+    pub background_colour: Option<String>,
 }
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, PartialEq, ToSchema)]
@@ -2861,6 +2867,12 @@ pub struct PaymentLinkConfig {
     pub custom_message_for_card_terms: Option<String>,
     /// Custom background colour for payment link's handle confirm button
     pub payment_button_colour: Option<String>,
+    /// Skip the status screen after payment completion
+    pub skip_status_screen: Option<bool>,
+    /// Custom text colour for payment link's handle confirm button
+    pub payment_button_text_colour: Option<String>,
+    /// Custom background colour for the payment link
+    pub background_colour: Option<String>,
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
@@ -7894,8 +7894,11 @@ pub struct PaymentLinkDetails {
     pub details_layout: Option<api_enums::PaymentLinkDetailsLayout>,
     pub branding_visibility: Option<bool>,
     pub payment_button_text: Option<String>,
+    pub skip_status_screen: Option<bool>,
     pub custom_message_for_card_terms: Option<String>,
     pub payment_button_colour: Option<String>,
+    pub payment_button_text_colour: Option<String>,
+    pub background_colour: Option<String>,
 }
 
 #[derive(Debug, serde::Serialize, Clone)]
@@ -7906,8 +7909,11 @@ pub struct SecurePaymentLinkDetails {
     #[serde(flatten)]
     pub payment_link_details: PaymentLinkDetails,
     pub payment_button_text: Option<String>,
+    pub skip_status_screen: Option<bool>,
     pub custom_message_for_card_terms: Option<String>,
     pub payment_button_colour: Option<String>,
+    pub payment_button_text_colour: Option<String>,
+    pub background_colour: Option<String>,
 }
 
 #[derive(Debug, serde::Serialize)]
diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs
@@ -629,6 +629,9 @@ pub struct PaymentLinkConfigRequest {
     pub payment_button_text: Option<String>,
     pub custom_message_for_card_terms: Option<String>,
     pub payment_button_colour: Option<String>,
+    pub skip_status_screen: Option<bool>,
+    pub payment_button_text_colour: Option<String>,
+    pub background_colour: Option<String>,
 }
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, PartialEq)]
diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs
@@ -177,10 +177,16 @@ pub struct PaymentLinkConfigRequestForPayments {
     pub details_layout: Option<common_enums::PaymentLinkDetailsLayout>,
     /// Text for payment link's handle confirm button
     pub payment_button_text: Option<String>,
+    /// Skip the status screen after payment completion
+    pub skip_status_screen: Option<bool>,
     /// Text for customizing message for card terms
     pub custom_message_for_card_terms: Option<String>,
     /// Custom background colour for payment link's handle confirm button
     pub payment_button_colour: Option<String>,
+    /// Custom text colour for payment link's handle confirm button
+    pub payment_button_text_colour: Option<String>,
+    /// Custom background colour for the payment link
+    pub background_colour: Option<String>,
 }
 
 common_utils::impl_to_sql_from_sql_json!(PaymentLinkConfigRequestForPayments);
diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs
@@ -409,6 +409,9 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
             payment_button_text: item.payment_button_text,
             custom_message_for_card_terms: item.custom_message_for_card_terms,
             payment_button_colour: item.payment_button_colour,
+            skip_status_screen: item.skip_status_screen,
+            background_colour: item.background_colour,
+            payment_button_text_colour: item.payment_button_text_colour,
         }
     }
     fn convert_back(self) -> api_models::admin::PaymentLinkConfigRequest {
@@ -427,6 +430,9 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
             payment_button_text,
             custom_message_for_card_terms,
             payment_button_colour,
+            skip_status_screen,
+            background_colour,
+            payment_button_text_colour,
         } = self;
         api_models::admin::PaymentLinkConfigRequest {
             theme,
@@ -449,6 +455,9 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
             payment_button_text,
             custom_message_for_card_terms,
             payment_button_colour,
+            skip_status_screen,
+            background_colour,
+            payment_button_text_colour,
         }
     }
 }
diff --git a/crates/router/src/core/payment_link.rs b/crates/router/src/core/payment_link.rs
@@ -132,6 +132,9 @@ pub async fn form_payment_link_data(
                 payment_button_text: None,
                 custom_message_for_card_terms: None,
                 payment_button_colour: None,
+                skip_status_screen: None,
+                background_colour: None,
+                payment_button_text_colour: None,
             }
         };
 
@@ -280,6 +283,9 @@ pub async fn form_payment_link_data(
         payment_button_text: payment_link_config.payment_button_text.clone(),
         custom_message_for_card_terms: payment_link_config.custom_message_for_card_terms.clone(),
         payment_button_colour: payment_link_config.payment_button_colour.clone(),
+        skip_status_screen: payment_link_config.skip_status_screen,
+        background_colour: payment_link_config.background_colour.clone(),
+        payment_button_text_colour: payment_link_config.payment_button_text_colour.clone(),
     };
 
     Ok((
@@ -333,6 +339,9 @@ pub async fn initiate_secure_payment_link_flow(
                 payment_button_text: payment_link_config.payment_button_text,
                 custom_message_for_card_terms: payment_link_config.custom_message_for_card_terms,
                 payment_button_colour: payment_link_config.payment_button_colour,
+                skip_status_screen: payment_link_config.skip_status_screen,
+                background_colour: payment_link_config.background_colour,
+                payment_button_text_colour: payment_link_config.payment_button_text_colour,
             };
             let js_script = format!(
                 "window.__PAYMENT_DETAILS = {}",
@@ -444,7 +453,10 @@ fn get_js_script(payment_details: &PaymentLinkData) -> RouterResult<String> {
 }
 
 fn get_color_scheme_css(payment_link_config: &PaymentLinkConfig) -> String {
-    let background_primary_color = payment_link_config.theme.clone();
+    let background_primary_color = payment_link_config
+        .background_colour
+        .clone()
+        .unwrap_or(payment_link_config.theme.clone());
     format!(
         ":root {{
       --primary-color: {background_primary_color};
@@ -638,6 +650,9 @@ pub fn get_payment_link_config_based_on_priority(
         payment_button_text,
         custom_message_for_card_terms,
         payment_button_colour,
+        skip_status_screen,
+        background_colour,
+        payment_button_text_colour,
     ) = get_payment_link_config_value!(
         payment_create_link_config,
         business_theme_configs,
@@ -647,6 +662,9 @@ pub fn get_payment_link_config_based_on_priority(
         (payment_button_text),
         (custom_message_for_card_terms),
         (payment_button_colour),
+        (skip_status_screen),
+        (background_colour),
+        (payment_button_text_colour)
     );
 
     let payment_link_config =
@@ -661,6 +679,7 @@ pub fn get_payment_link_config_based_on_priority(
             show_card_form_by_default,
             allowed_domains,
             branding_visibility,
+            skip_status_screen,
             transaction_details: payment_create_link_config.as_ref().and_then(
                 |payment_link_config| payment_link_config.theme_config.transaction_details.clone(),
             ),
@@ -669,6 +688,8 @@ pub fn get_payment_link_config_based_on_priority(
             payment_button_text,
             custom_message_for_card_terms,
             payment_button_colour,
+            background_colour,
+            payment_button_text_colour,
         };
 
     Ok((payment_link_config, domain_name))
@@ -774,6 +795,9 @@ pub async fn get_payment_link_status(
             payment_button_text: None,
             custom_message_for_card_terms: None,
             payment_button_colour: None,
+            skip_status_screen: None,
+            background_colour: None,
+            payment_button_text_colour: None,
         }
     };
 
diff --git a/crates/router/src/core/payment_link/payment_link_initiate/payment_link.js b/crates/router/src/core/payment_link/payment_link_initiate/payment_link.js
@@ -307,8 +307,9 @@ function initializeEventListeners(paymentDetails) {
   }
 
   if (submitButtonNode instanceof HTMLButtonElement) {
-    submitButtonNode.style.color = contrastBWColor;
-    submitButtonNode.style.backgroundColor = paymentDetails.payment_button_colour || primaryColor;
+    var chosenColor = paymentDetails.payment_button_colour || primaryColor;
+    submitButtonNode.style.color = paymentDetails.payment_button_text_colour || invert(chosenColor, true);
+    submitButtonNode.style.backgroundColor = chosenColor;
   }
 
   if (hyperCheckoutCartImageNode instanceof HTMLDivElement) {
@@ -442,9 +443,25 @@ function handleSubmit(e) {
         } else {
           showMessage(translations.unexpectedError);
         }
+      } else if (paymentDetails.skip_status_screen) {
+        // Form query params
+        var queryParams = {
+          payment_id: paymentDetails.payment_id,
+          status: result.status
+        };
+        var url = new URL(paymentDetails.return_url);
+        var params = new URLSearchParams(url.search);
+        // Attach query params to return_url
+        for (var key in queryParams) {
+          if (queryParams.hasOwnProperty(key)) {
+            params.set(key, queryParams[key]);
+          }
+        }
+        url.search = params.toString();
+        window.top.location.href = url.toString();
       } else {
         redirectToStatus();
-      }
+    }
     })
     .catch(function (error) {
       console.error("Error confirming payment_intent", error);
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
@@ -4376,6 +4376,9 @@ impl ForeignFrom<api_models::admin::PaymentLinkConfigRequest>
             payment_button_text: config.payment_button_text,
             custom_message_for_card_terms: config.custom_message_for_card_terms,
             payment_button_colour: config.payment_button_colour,
+            skip_status_screen: config.skip_status_screen,
+            background_colour: config.background_colour,
+            payment_button_text_colour: config.payment_button_text_colour,
         }
     }
 }
@@ -4441,6 +4444,9 @@ impl ForeignFrom<diesel_models::PaymentLinkConfigRequestForPayments>
             payment_button_text: config.payment_button_text,
             custom_message_for_card_terms: config.custom_message_for_card_terms,
             payment_button_colour: config.payment_button_colour,
+            skip_status_screen: config.skip_status_screen,
+            background_colour: config.background_colour,
+            payment_button_text_colour: config.payment_button_text_colour,
         }
     }
 }
diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs
@@ -2155,8 +2155,11 @@ impl ForeignFrom<api_models::admin::PaymentLinkConfigRequest>
                 .background_image
                 .map(|background_image| background_image.foreign_into()),
             payment_button_text: item.payment_button_text,
+            skip_status_screen: item.skip_status_screen,
             custom_message_for_card_terms: item.custom_message_for_card_terms,
             payment_button_colour: item.payment_button_colour,
+            background_colour: item.background_colour,
+            payment_button_text_colour: item.payment_button_text_colour,
         }
     }
 }
@@ -2180,8 +2183,11 @@ impl ForeignFrom<diesel_models::business_profile::PaymentLinkConfigRequest>
                 .background_image
                 .map(|background_image| background_image.foreign_into()),
             payment_button_text: item.payment_button_text,
+            skip_status_screen: item.skip_status_screen,
             custom_message_for_card_terms: item.custom_message_for_card_terms,
             payment_button_colour: item.payment_button_colour,
+            background_colour: item.background_colour,
+            payment_button_text_colour: item.payment_button_text_colour,
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -629,6 +629,9 @@ pub struct PaymentLinkConfigRequest {`
`629`	`629`	`pub payment_button_text: Option<String>,`
`630`	`630`	`pub custom_message_for_card_terms: Option<String>,`
`631`	`631`	`pub payment_button_colour: Option<String>,`
	`632`	`+ pub skip_status_screen: Option<bool>,`
	`633`	`+ pub payment_button_text_colour: Option<String>,`
	`634`	`+ pub background_colour: Option<String>,`
`632`	`635`	`}`
`633`	`636`
`634`	`637`	`#[derive(Clone, Debug, serde::Deserialize, serde::Serialize, PartialEq)]`
Original file line number	Diff line number	Diff line change
`@@ -409,6 +409,9 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>`
`409`	`409`	`payment_button_text: item.payment_button_text,`
`410`	`410`	`custom_message_for_card_terms: item.custom_message_for_card_terms,`
`411`	`411`	`payment_button_colour: item.payment_button_colour,`
	`412`	`+ skip_status_screen: item.skip_status_screen,`
	`413`	`+ background_colour: item.background_colour,`
	`414`	`+ payment_button_text_colour: item.payment_button_text_colour,`
`412`	`415`	`}`
`413`	`416`	`}`
`414`	`417`	`fn convert_back(self) -> api_models::admin::PaymentLinkConfigRequest {`
`@@ -427,6 +430,9 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>`
`427`	`430`	`payment_button_text,`
`428`	`431`	`custom_message_for_card_terms,`
`429`	`432`	`payment_button_colour,`
	`433`	`+ skip_status_screen,`
	`434`	`+ background_colour,`
	`435`	`+ payment_button_text_colour,`
`430`	`436`	`} = self;`
`431`	`437`	`api_models::admin::PaymentLinkConfigRequest {`
`432`	`438`	`theme,`
`@@ -449,6 +455,9 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>`
`449`	`455`	`payment_button_text,`
`450`	`456`	`custom_message_for_card_terms,`
`451`	`457`	`payment_button_colour,`
	`458`	`+ skip_status_screen,`
	`459`	`+ background_colour,`
	`460`	`+ payment_button_text_colour,`
`452`	`461`	`}`
`453`	`462`	`}`
`454`	`463`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4376,6 +4376,9 @@ impl ForeignFrom<api_models::admin::PaymentLinkConfigRequest>`
`4376`	`4376`	`payment_button_text: config.payment_button_text,`
`4377`	`4377`	`custom_message_for_card_terms: config.custom_message_for_card_terms,`
`4378`	`4378`	`payment_button_colour: config.payment_button_colour,`
	`4379`	`+ skip_status_screen: config.skip_status_screen,`
	`4380`	`+ background_colour: config.background_colour,`
	`4381`	`+ payment_button_text_colour: config.payment_button_text_colour,`
`4379`	`4382`	`}`
`4380`	`4383`	`}`
`4381`	`4384`	`}`
`@@ -4441,6 +4444,9 @@ impl ForeignFrom<diesel_models::PaymentLinkConfigRequestForPayments>`
`4441`	`4444`	`payment_button_text: config.payment_button_text,`
`4442`	`4445`	`custom_message_for_card_terms: config.custom_message_for_card_terms,`
`4443`	`4446`	`payment_button_colour: config.payment_button_colour,`
	`4447`	`+ skip_status_screen: config.skip_status_screen,`
	`4448`	`+ background_colour: config.background_colour,`
	`4449`	`+ payment_button_text_colour: config.payment_button_text_colour,`
`4444`	`4450`	`}`
`4445`	`4451`	`}`
`4446`	`4452`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2155,8 +2155,11 @@ impl ForeignFrom<api_models::admin::PaymentLinkConfigRequest>`
`2155`	`2155`	`.background_image`
`2156`	`2156`	`.map(\|background_image\| background_image.foreign_into()),`
`2157`	`2157`	`payment_button_text: item.payment_button_text,`
	`2158`	`+ skip_status_screen: item.skip_status_screen,`
`2158`	`2159`	`custom_message_for_card_terms: item.custom_message_for_card_terms,`
`2159`	`2160`	`payment_button_colour: item.payment_button_colour,`
	`2161`	`+ background_colour: item.background_colour,`
	`2162`	`+ payment_button_text_colour: item.payment_button_text_colour,`
`2160`	`2163`	`}`
`2161`	`2164`	`}`
`2162`	`2165`	`}`
`@@ -2180,8 +2183,11 @@ impl ForeignFrom<diesel_models::business_profile::PaymentLinkConfigRequest>`
`2180`	`2183`	`.background_image`
`2181`	`2184`	`.map(\|background_image\| background_image.foreign_into()),`
`2182`	`2185`	`payment_button_text: item.payment_button_text,`
	`2186`	`+ skip_status_screen: item.skip_status_screen,`
`2183`	`2187`	`custom_message_for_card_terms: item.custom_message_for_card_terms,`
`2184`	`2188`	`payment_button_colour: item.payment_button_colour,`
	`2189`	`+ background_colour: item.background_colour,`
	`2190`	`+ payment_button_text_colour: item.payment_button_text_colour,`
`2185`	`2191`	`}`
`2186`	`2192`	`}`
`2187`	`2193`	`}`