feat(payment_link): expose payment link configs for SDK UI rules and payment button

api-reference-v2/openapi_spec.json

@@ -12587,6 +12587,14 @@
                 "type": "string",
                 "description": "The url for Qr code given by the connector"
               },
+              "display_text": {
+                "type": "string",
+                "nullable": true
+              },
+              "border_color": {
+                "type": "string",
+                "nullable": true
+              },
               "type": {
                 "type": "string",
                 "enum": [
@@ -13983,6 +13991,28 @@
             "type": "string",
             "description": "Custom background colour for the payment link",
             "nullable": true
+          },
+          "sdk_ui_rules": {
+            "type": "object",
+            "description": "SDK configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
+          },
+          "payment_link_ui_rules": {
+            "type": "object",
+            "description": "Payment link configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
           }
         }
       },
@@ -14098,6 +14128,28 @@
             "type": "string",
             "description": "Custom background colour for the payment link",
             "nullable": true
+          },
+          "sdk_ui_rules": {
+            "type": "object",
+            "description": "SDK configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
+          },
+          "payment_link_ui_rules": {
+            "type": "object",
+            "description": "Payment link configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
           }
         }
       },
@@ -15301,13 +15353,29 @@
             "description": "The return url to which the user should be redirected to",
             "nullable": true
           },
-          "associated_payment": {
+          "next_action": {
             "allOf": [
               {
-                "$ref": "#/components/schemas/PaymentsResponse"
+                "$ref": "#/components/schemas/NextActionData"
               }
             ],
             "nullable": true
+          },
+          "authentication_details": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/AuthenticationDetails"
+              }
+            ],
+            "nullable": true
+          },
+          "associated_payment_methods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/id_type.GlobalPaymentMethodId"
+            },
+            "description": "The payment method that was created using this payment method session",
+            "nullable": true
           }
         }
       },
@@ -15542,60 +15610,6 @@
         },
         "additionalProperties": false
       },
-      "PaymentMethodsSessionResponse": {
-        "type": "object",
-        "required": [
-          "id",
-          "customer_id",
-          "expires_at",
-          "client_secret"
-        ],
-        "properties": {
-          "id": {
-            "type": "string",
-            "example": "12345_pms_01926c58bc6e77c09e809964e72af8c8"
-          },
-          "customer_id": {
-            "type": "string",
-            "description": "The customer id for which the payment methods session is to be created",
-            "example": "12345_cus_01926c58bc6e77c09e809964e72af8c8"
-          },
-          "billing": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/Address"
-              }
-            ],
-            "nullable": true
-          },
-          "psp_tokenization": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/PspTokenization"
-              }
-            ],
-            "nullable": true
-          },
-          "network_tokenization": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/NetworkTokenization"
-              }
-            ],
-            "nullable": true
-          },
-          "expires_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "The iso timestamp when the session will expire\nTrying to retrieve the session or any operations on the session after this time will result in an error",
-            "example": "2023-01-18T11:04:09.922Z"
-          },
-          "client_secret": {
-            "type": "string",
-            "description": "Client Secret"
-          }
-        }
-      },
       "PaymentMethodsSessionUpdateRequest": {
         "type": "object",
         "properties": {

api-reference/openapi_spec.json

@@ -16543,6 +16543,28 @@
             "type": "string",
             "description": "Custom background colour for the payment link",
             "nullable": true
+          },
+          "sdk_ui_rules": {
+            "type": "object",
+            "description": "SDK configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
+          },
+          "payment_link_ui_rules": {
+            "type": "object",
+            "description": "Payment link configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
           }
         }
       },
@@ -16658,6 +16680,28 @@
             "type": "string",
             "description": "Custom background colour for the payment link",
             "nullable": true
+          },
+          "sdk_ui_rules": {
+            "type": "object",
+            "description": "SDK configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
+          },
+          "payment_link_ui_rules": {
+            "type": "object",
+            "description": "Payment link configuration rules",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "nullable": true
           }
         }
       },

crates/api_models/src/admin.rs

@@ -2810,6 +2810,10 @@ pub struct PaymentLinkConfigRequest {
     pub payment_button_text_colour: Option<String>,
     /// Custom background colour for the payment link
     pub background_colour: Option<String>,
+    /// SDK configuration rules
+    pub sdk_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
+    /// Payment link configuration rules
+    pub payment_link_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
 }
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, PartialEq, ToSchema)]
@@ -2891,6 +2895,10 @@ pub struct PaymentLinkConfig {
     pub payment_button_text_colour: Option<String>,
     /// Custom background colour for the payment link
     pub background_colour: Option<String>,
+    /// SDK configuration rules
+    pub sdk_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
+    /// Payment link configuration rules
+    pub payment_link_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
 }
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]

crates/api_models/src/payments.rs

@@ -7831,6 +7831,8 @@ pub struct PaymentLinkDetails {
     pub payment_button_colour: Option<String>,
     pub payment_button_text_colour: Option<String>,
     pub background_colour: Option<String>,
+    pub sdk_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
+    pub payment_link_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
 }
 
 #[derive(Debug, serde::Serialize, Clone)]
@@ -7846,6 +7848,8 @@ pub struct SecurePaymentLinkDetails {
     pub payment_button_colour: Option<String>,
     pub payment_button_text_colour: Option<String>,
     pub background_colour: Option<String>,
+    pub sdk_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
+    pub payment_link_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
 }
 
 #[derive(Debug, serde::Serialize)]

crates/diesel_models/src/business_profile.rs

@@ -644,6 +644,8 @@ pub struct PaymentLinkConfigRequest {
     pub skip_status_screen: Option<bool>,
     pub payment_button_text_colour: Option<String>,
     pub background_colour: Option<String>,
+    pub sdk_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
+    pub payment_link_ui_rules: Option<HashMap<String, HashMap<String, String>>>,
 }
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, PartialEq)]

crates/diesel_models/src/payment_intent.rs

@@ -187,6 +187,12 @@ pub struct PaymentLinkConfigRequestForPayments {
     pub payment_button_text_colour: Option<String>,
     /// Custom background colour for the payment link
     pub background_colour: Option<String>,
+    /// SDK configuration rules
+    pub sdk_ui_rules:
+        Option<std::collections::HashMap<String, std::collections::HashMap<String, String>>>,
+    /// Payment link configuration rules
+    pub payment_link_ui_rules:
+        Option<std::collections::HashMap<String, std::collections::HashMap<String, String>>>,
 }
 
 common_utils::impl_to_sql_from_sql_json!(PaymentLinkConfigRequestForPayments);

crates/hyperswitch_domain_models/src/lib.rs

@@ -412,6 +412,8 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
             skip_status_screen: item.skip_status_screen,
             background_colour: item.background_colour,
             payment_button_text_colour: item.payment_button_text_colour,
+            sdk_ui_rules: item.sdk_ui_rules,
+            payment_link_ui_rules: item.payment_link_ui_rules,
         }
     }
     fn convert_back(self) -> api_models::admin::PaymentLinkConfigRequest {
@@ -433,6 +435,8 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
             skip_status_screen,
             background_colour,
             payment_button_text_colour,
+            sdk_ui_rules,
+            payment_link_ui_rules,
         } = self;
         api_models::admin::PaymentLinkConfigRequest {
             theme,
@@ -458,6 +462,8 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
             skip_status_screen,
             background_colour,
             payment_button_text_colour,
+            sdk_ui_rules,
+            payment_link_ui_rules,
         }
     }
 }

crates/router/src/core/payment_link.rs

@@ -135,6 +135,8 @@ pub async fn form_payment_link_data(
                 skip_status_screen: None,
                 background_colour: None,
                 payment_button_text_colour: None,
+                sdk_ui_rules: None,
+                payment_link_ui_rules: None,
             }
         };
 
@@ -286,6 +288,8 @@ pub async fn form_payment_link_data(
         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(),
+        sdk_ui_rules: payment_link_config.sdk_ui_rules.clone(),
+        payment_link_ui_rules: payment_link_config.payment_link_ui_rules.clone(),
     };
 
     Ok((
@@ -342,6 +346,8 @@ pub async fn initiate_secure_payment_link_flow(
                 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,
+                sdk_ui_rules: payment_link_config.sdk_ui_rules,
+                payment_link_ui_rules: payment_link_config.payment_link_ui_rules,
             };
             let js_script = format!(
                 "window.__PAYMENT_DETAILS = {}",
@@ -653,6 +659,8 @@ pub fn get_payment_link_config_based_on_priority(
         skip_status_screen,
         background_colour,
         payment_button_text_colour,
+        sdk_ui_rules,
+        payment_link_ui_rules,
     ) = get_payment_link_config_value!(
         payment_create_link_config,
         business_theme_configs,
@@ -664,7 +672,9 @@ pub fn get_payment_link_config_based_on_priority(
         (payment_button_colour),
         (skip_status_screen),
         (background_colour),
-        (payment_button_text_colour)
+        (payment_button_text_colour),
+        (sdk_ui_rules),
+        (payment_link_ui_rules),
     );
 
     let payment_link_config =
@@ -690,6 +700,8 @@ pub fn get_payment_link_config_based_on_priority(
             payment_button_colour,
             background_colour,
             payment_button_text_colour,
+            sdk_ui_rules,
+            payment_link_ui_rules,
         };
 
     Ok((payment_link_config, domain_name))
@@ -798,6 +810,8 @@ pub async fn get_payment_link_status(
             skip_status_screen: None,
             background_colour: None,
             payment_button_text_colour: None,
+            sdk_ui_rules: None,
+            payment_link_ui_rules: None,
         }
     };