feat(core): Payments core modification for open banking connectors (#3947)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

Author: Sarthak1799

api-reference/openapi_spec.json

@@ -12714,6 +12714,33 @@
         },
         "additionalProperties": false
       },
+      "OpenBankingData": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "open_banking_pis"
+            ],
+            "properties": {
+              "open_banking_pis": {
+                "type": "object"
+              }
+            }
+          }
+        ]
+      },
+      "OpenBankingSessionToken": {
+        "type": "object",
+        "required": [
+          "open_banking_session_token"
+        ],
+        "properties": {
+          "open_banking_session_token": {
+            "type": "string",
+            "description": "The session token for OpenBanking Connectors"
+          }
+        }
+      },
       "OrderDetails": {
         "type": "object",
         "required": [
@@ -13737,7 +13764,8 @@
           "real_time_payment",
           "upi",
           "voucher",
-          "gift_card"
+          "gift_card",
+          "open_banking"
         ]
       },
       "PaymentMethodCollectLinkRequest": {
@@ -14132,6 +14160,18 @@
                 "$ref": "#/components/schemas/CardToken"
               }
             }
+          },
+          {
+            "type": "object",
+            "title": "OpenBanking",
+            "required": [
+              "open_banking"
+            ],
+            "properties": {
+              "open_banking": {
+                "$ref": "#/components/schemas/OpenBankingData"
+              }
+            }
           }
         ]
       },
@@ -14338,6 +14378,17 @@
                 "type": "object"
               }
             }
+          },
+          {
+            "type": "object",
+            "required": [
+              "open_banking"
+            ],
+            "properties": {
+              "open_banking": {
+                "type": "object"
+              }
+            }
           }
         ]
       },
@@ -14700,7 +14751,8 @@
           "seicomart",
           "pay_easy",
           "local_bank_transfer",
-          "mifinity"
+          "mifinity",
+          "open_banking_pis"
         ]
       },
       "PaymentMethodUpdate": {
@@ -20171,6 +20223,27 @@
               }
             ]
           },
+          {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OpenBankingSessionToken"
+              },
+              {
+                "type": "object",
+                "required": [
+                  "wallet_name"
+                ],
+                "properties": {
+                  "wallet_name": {
+                    "type": "string",
+                    "enum": [
+                      "open_banking"
+                    ]
+                  }
+                }
+              }
+            ]
+          },
           {
             "type": "object",
             "required": [

crates/api_models/src/payments.rs

@@ -1600,6 +1600,7 @@ mod payment_method_data_serde {
                     | PaymentMethodData::Voucher(_)
                     | PaymentMethodData::Card(_)
                     | PaymentMethodData::MandatePayment
+                    | PaymentMethodData::OpenBanking(_)
                     | PaymentMethodData::Wallet(_) => {
                         payment_method_data_request.serialize(serializer)
                     }
@@ -1657,6 +1658,8 @@ pub enum PaymentMethodData {
     GiftCard(Box<GiftCardData>),
     #[schema(title = "CardToken")]
     CardToken(CardToken),
+    #[schema(title = "OpenBanking")]
+    OpenBanking(OpenBankingData),
 }
 
 pub trait GetAddressFromPaymentMethodData {
@@ -1680,6 +1683,7 @@ impl GetAddressFromPaymentMethodData for PaymentMethodData {
             | Self::Upi(_)
             | Self::GiftCard(_)
             | Self::CardToken(_)
+            | Self::OpenBanking(_)
             | Self::MandatePayment => None,
         }
     }
@@ -1717,6 +1721,7 @@ impl PaymentMethodData {
             Self::Upi(_) => Some(api_enums::PaymentMethod::Upi),
             Self::Voucher(_) => Some(api_enums::PaymentMethod::Voucher),
             Self::GiftCard(_) => Some(api_enums::PaymentMethod::GiftCard),
+            Self::OpenBanking(_) => Some(api_enums::PaymentMethod::OpenBanking),
             Self::CardToken(_) | Self::MandatePayment => None,
         }
     }
@@ -1785,6 +1790,14 @@ impl GetPaymentMethodType for PayLaterData {
     }
 }
 
+impl GetPaymentMethodType for OpenBankingData {
+    fn get_payment_method_type(&self) -> api_enums::PaymentMethodType {
+        match self {
+            Self::OpenBankingPIS {} => api_enums::PaymentMethodType::OpenBankingPIS,
+        }
+    }
+}
+
 impl GetPaymentMethodType for BankRedirectData {
     fn get_payment_method_type(&self) -> api_enums::PaymentMethodType {
         match self {
@@ -1983,6 +1996,7 @@ pub enum AdditionalPaymentData {
     Voucher {},
     CardRedirect {},
     CardToken {},
+    OpenBanking {},
 }
 
 #[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
@@ -2673,6 +2687,12 @@ pub struct SamsungPayWalletData {
     pub token: Secret<String>,
 }
 
+#[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum OpenBankingData {
+    #[serde(rename = "open_banking_pis")]
+    OpenBankingPIS {},
+}
 #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)]
 #[serde(rename_all = "snake_case")]
 pub struct GooglePayWalletData {
@@ -2946,6 +2966,7 @@ where
                 | PaymentMethodDataResponse::Upi {}
                 | PaymentMethodDataResponse::Wallet {}
                 | PaymentMethodDataResponse::BankTransfer {}
+                | PaymentMethodDataResponse::OpenBanking {}
                 | PaymentMethodDataResponse::Voucher {} => {
                     payment_method_data_response.serialize(serializer)
                 }
@@ -2979,6 +3000,7 @@ pub enum PaymentMethodDataResponse {
     GiftCard {},
     CardRedirect {},
     CardToken {},
+    OpenBanking {},
 }
 
 #[derive(Eq, PartialEq, Clone, Debug, serde::Serialize, serde::Deserialize, ToSchema)]
@@ -4146,6 +4168,7 @@ impl From<AdditionalPaymentData> for PaymentMethodDataResponse {
             AdditionalPaymentData::GiftCard {} => Self::GiftCard {},
             AdditionalPaymentData::CardRedirect {} => Self::CardRedirect {},
             AdditionalPaymentData::CardToken {} => Self::CardToken {},
+            AdditionalPaymentData::OpenBanking {} => Self::OpenBanking {},
         }
     }
 }
@@ -4531,6 +4554,8 @@ pub enum SessionToken {
     Paypal(Box<PaypalSessionTokenResponse>),
     /// The session response structure for Apple Pay
     ApplePay(Box<ApplepaySessionTokenResponse>),
+    /// Session token for OpenBanking PIS flow
+    OpenBanking(OpenBankingSessionToken),
     /// Whenever there is no session token response or an error in session response
     NoSessionTokenReceived,
 }
@@ -4607,6 +4632,13 @@ pub struct PaypalSessionTokenResponse {
     pub sdk_next_action: SdkNextAction,
 }
 
+#[derive(Debug, Clone, Eq, PartialEq, serde::Serialize, ToSchema)]
+#[serde(rename_all = "lowercase")]
+pub struct OpenBankingSessionToken {
+    /// The session token for OpenBanking Connectors
+    pub open_banking_session_token: String,
+}
+
 #[derive(Debug, Clone, Eq, PartialEq, serde::Serialize, ToSchema)]
 #[serde(rename_all = "lowercase")]
 pub struct ApplepaySessionTokenResponse {

crates/common_enums/src/enums.rs

@@ -1569,6 +1569,8 @@ pub enum PaymentMethodType {
     PayEasy,
     LocalBankTransfer,
     Mifinity,
+    #[serde(rename = "open_banking_pis")]
+    OpenBankingPIS,
 }
 
 /// Indicates the type of payment method. Eg: 'card', 'wallet', etc.
@@ -1606,6 +1608,7 @@ pub enum PaymentMethod {
     Upi,
     Voucher,
     GiftCard,
+    OpenBanking,
 }
 
 /// The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

crates/common_enums/src/transformers.rs

@@ -1882,6 +1882,7 @@ impl From<PaymentMethodType> for PaymentMethod {
             PaymentMethodType::FamilyMart => Self::Voucher,
             PaymentMethodType::Seicomart => Self::Voucher,
             PaymentMethodType::PayEasy => Self::Voucher,
+            PaymentMethodType::OpenBankingPIS => Self::OpenBanking,
         }
     }
 }

crates/connector_configs/src/response_modifier.rs

@@ -19,6 +19,7 @@ impl ConnectorApiIntegrationPayload {
         let mut voucher_details: Vec<Provider> = Vec::new();
         let mut gift_card_details: Vec<Provider> = Vec::new();
         let mut card_redirect_details: Vec<Provider> = Vec::new();
+        let mut open_banking_details: Vec<Provider> = Vec::new();
 
         if let Some(payment_methods_enabled) = response.payment_methods_enabled.clone() {
             for methods in payment_methods_enabled {
@@ -160,6 +161,18 @@ impl ConnectorApiIntegrationPayload {
                             }
                         }
                     }
+                    api_models::enums::PaymentMethod::OpenBanking => {
+                        if let Some(payment_method_types) = methods.payment_method_types {
+                            for method_type in payment_method_types {
+                                open_banking_details.push(Provider {
+                                    payment_method_type: method_type.payment_method_type,
+                                    accepted_currencies: method_type.accepted_currencies.clone(),
+                                    accepted_countries: method_type.accepted_countries.clone(),
+                                    payment_experience: method_type.payment_experience,
+                                })
+                            }
+                        }
+                    }
                     api_models::enums::PaymentMethod::Upi => {
                         if let Some(payment_method_types) = methods.payment_method_types {
                             for method_type in payment_method_types {

crates/connector_configs/src/transformer.rs

@@ -138,6 +138,7 @@ impl DashboardRequestPayload {
                     | PaymentMethod::Upi
                     | PaymentMethod::Voucher
                     | PaymentMethod::GiftCard
+                    | PaymentMethod::OpenBanking
                     | PaymentMethod::CardRedirect => {
                         if let Some(provider) = payload.provider {
                             let val = Self::transform_payment_method(

crates/euclid/src/dssa/graph.rs

@@ -69,6 +69,7 @@ impl cgraph::NodeViz for dir::DirValue {
             Self::SetupFutureUsage(sfu) => sfu.to_string(),
             Self::CardRedirectType(crt) => crt.to_string(),
             Self::RealTimePaymentType(rtpt) => rtpt.to_string(),
+            Self::OpenBankingType(ob) => ob.to_string(),
         }
     }
 }

crates/euclid/src/frontend/ast/lowering.rs

@@ -264,6 +264,8 @@ fn lower_comparison_inner<O: EuclidDirFilter>(
 
         dir::DirKeyKind::UpiType => lower_enum!(UpiType, value),
 
+        dir::DirKeyKind::OpenBankingType => lower_enum!(OpenBankingType, value),
+
         dir::DirKeyKind::VoucherType => lower_enum!(VoucherType, value),
 
         dir::DirKeyKind::GiftCardType => lower_enum!(GiftCardType, value),

crates/euclid/src/frontend/dir.rs

@@ -319,6 +319,13 @@ pub enum DirKeyKind {
         props(Category = "Payment Method Types")
     )]
     RealTimePaymentType,
+    #[serde(rename = "open_banking")]
+    #[strum(
+        serialize = "open_banking",
+        detailed_message = "Supported types of open banking payment method",
+        props(Category = "Payment Method Types")
+    )]
+    OpenBankingType,
 }
 
 pub trait EuclidDirFilter: Sized
@@ -367,6 +374,7 @@ impl DirKeyKind {
             Self::SetupFutureUsage => types::DataType::EnumVariant,
             Self::CardRedirectType => types::DataType::EnumVariant,
             Self::RealTimePaymentType => types::DataType::EnumVariant,
+            Self::OpenBankingType => types::DataType::EnumVariant,
         }
     }
     pub fn get_value_set(&self) -> Option<Vec<DirValue>> {
@@ -498,6 +506,11 @@ impl DirKeyKind {
                     .map(DirValue::RealTimePaymentType)
                     .collect(),
             ),
+            Self::OpenBankingType => Some(
+                enums::OpenBankingType::iter()
+                    .map(DirValue::OpenBankingType)
+                    .collect(),
+            ),
         }
     }
 }
@@ -565,6 +578,8 @@ pub enum DirValue {
     CardRedirectType(enums::CardRedirectType),
     #[serde(rename = "real_time_payment")]
     RealTimePaymentType(enums::RealTimePaymentType),
+    #[serde(rename = "open_banking")]
+    OpenBankingType(enums::OpenBankingType),
 }
 
 impl DirValue {
@@ -599,6 +614,7 @@ impl DirValue {
             Self::VoucherType(_) => (DirKeyKind::VoucherType, None),
             Self::GiftCardType(_) => (DirKeyKind::GiftCardType, None),
             Self::RealTimePaymentType(_) => (DirKeyKind::RealTimePaymentType, None),
+            Self::OpenBankingType(_) => (DirKeyKind::OpenBankingType, None),
         };
 
         DirKey::new(kind, data)
@@ -634,6 +650,7 @@ impl DirValue {
             Self::SetupFutureUsage(_) => None,
             Self::CardRedirectType(_) => None,
             Self::RealTimePaymentType(_) => None,
+            Self::OpenBankingType(_) => None,
         }
     }