feat(mca): Added recipient connector call for open banking connectors

api-reference/openapi_spec.json

@@ -4887,6 +4887,21 @@
           }
         }
       },
+      "AdditionalMerchantData": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "open_banking_recipient_data"
+            ],
+            "properties": {
+              "open_banking_recipient_data": {
+                "$ref": "#/components/schemas/MerchantRecipientData"
+              }
+            }
+          }
+        ]
+      },
       "Address": {
         "type": "object",
         "properties": {
@@ -11224,6 +11239,76 @@
         },
         "additionalProperties": false
       },
+      "MerchantAccountData": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "Iban"
+            ],
+            "properties": {
+              "Iban": {
+                "type": "object",
+                "required": [
+                  "iban",
+                  "name"
+                ],
+                "properties": {
+                  "iban": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "connector_recipient_id": {
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/RecipientIdType"
+                      }
+                    ],
+                    "nullable": true
+                  }
+                }
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "Bacs"
+            ],
+            "properties": {
+              "Bacs": {
+                "type": "object",
+                "required": [
+                  "account_number",
+                  "sort_code",
+                  "name"
+                ],
+                "properties": {
+                  "account_number": {
+                    "type": "string"
+                  },
+                  "sort_code": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "connector_recipient_id": {
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/RecipientIdType"
+                      }
+                    ],
+                    "nullable": true
+                  }
+                }
+              }
+            }
+          }
+        ]
+      },
       "MerchantAccountDeleteResponse": {
         "type": "object",
         "required": [
@@ -11668,6 +11753,14 @@
               }
             ],
             "nullable": true
+          },
+          "additional_merchant_data": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/AdditionalMerchantData"
+              }
+            ],
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -11903,6 +11996,14 @@
           },
           "status": {
             "$ref": "#/components/schemas/ConnectorStatus"
+          },
+          "additional_merchant_data": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/AdditionalMerchantData"
+              }
+            ],
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -12109,6 +12210,45 @@
         },
         "additionalProperties": false
       },
+      "MerchantRecipientData": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "ConnectorRecipientId"
+            ],
+            "properties": {
+              "ConnectorRecipientId": {
+                "type": "string",
+                "nullable": true
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "WalletId"
+            ],
+            "properties": {
+              "WalletId": {
+                "type": "string",
+                "nullable": true
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "AccountData"
+            ],
+            "properties": {
+              "AccountData": {
+                "$ref": "#/components/schemas/MerchantAccountData"
+              }
+            }
+          }
+        ]
+      },
       "MerchantRoutingAlgorithm": {
         "type": "object",
         "description": "Routing Algorithm specific to merchants",
@@ -18731,6 +18871,32 @@
           }
         }
       },
+      "RecipientIdType": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "ConnectorId"
+            ],
+            "properties": {
+              "ConnectorId": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "LockerId"
+            ],
+            "properties": {
+              "LockerId": {
+                "type": "string"
+              }
+            }
+          }
+        ]
+      },
       "ReconStatus": {
         "type": "string",
         "enum": [
@@ -19490,6 +19656,7 @@
           "worldline",
           "worldpay",
           "zen",
+          "plaid",
           "zsl"
         ]
       },

config/config.example.toml

@@ -689,3 +689,6 @@ public = { name = "hyperswitch", base_url = "http://localhost:8080", schema = "p
 
 [user_auth_methods]
 encryption_key = "" # Encryption key used for encrypting data in user_authentication_methods table
+
+[locker_based_open_banking_connectors]
+connector_list = ""

config/deployments/integration_test.toml

@@ -341,3 +341,6 @@ keys = "user-agent"
 
 [saved_payment_methods]
 sdk_eligible_payment_methods = "card"
+
+[locker_based_open_banking_connectors]
+connector_list = ""

config/deployments/production.toml

@@ -360,3 +360,6 @@ keys = "user-agent"
 
 [saved_payment_methods]
 sdk_eligible_payment_methods = "card"
+
+[locker_based_open_banking_connectors]
+connector_list = ""

config/deployments/sandbox.toml

@@ -364,3 +364,6 @@ keys = "user-agent"
 
 [saved_payment_methods]
 sdk_eligible_payment_methods = "card"
+
+[locker_based_open_banking_connectors]
+connector_list = ""

config/development.toml

@@ -688,3 +688,6 @@ public = { name = "hyperswitch", base_url = "http://localhost:8080", schema = "p
 
 [user_auth_methods]
 encryption_key = "A8EF32E029BC3342E54BF2E172A4D7AA43E8EF9D2C3A624A9F04E2EF79DC698F"
+
+[locker_based_open_banking_connectors]
+connector_list = ""

config/docker_compose.toml

@@ -545,3 +545,6 @@ merchant_name = "HyperSwitch"
 card = "credit,debit"
 bank_transfer = "ach,bacs,sepa"
 wallet = "paypal,pix,venmo"
+
+[locker_based_open_banking_connectors]
+connector_list = ""

crates/api_models/src/admin.rs

@@ -652,6 +652,51 @@ pub struct MerchantConnectorCreate {
 
     #[schema(value_type = Option<ConnectorStatus>, example = "inactive")]
     pub status: Option<api_enums::ConnectorStatus>,
+
+    /// In case the merchant needs to store any additional sensitive data
+    #[schema(value_type = Option<AdditionalMerchantData>)]
+    pub additional_merchant_data: Option<pii::SecretSerdeValue>,
+}
+
+#[derive(Debug, Clone, serde::Deserialize, serde::Serialize, ToSchema)]
+pub enum RecipientIdType {
+    #[schema(value_type= String)]
+    ConnectorId(Secret<String>),
+    #[schema(value_type= String)]
+    LockerId(Secret<String>),
+}
+
+#[derive(Debug, Clone, serde::Deserialize, serde::Serialize, ToSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum AdditionalMerchantData {
+    OpenBankingRecipientData(MerchantRecipientData),
+}
+
+#[derive(Debug, Clone, serde::Deserialize, serde::Serialize, ToSchema)]
+pub enum MerchantAccountData {
+    Iban {
+        #[schema(value_type= String)]
+        iban: Secret<String>,
+        name: String,
+        connector_recipient_id: Option<RecipientIdType>,
+    },
+    Bacs {
+        #[schema(value_type= String)]
+        account_number: Secret<String>,
+        #[schema(value_type= String)]
+        sort_code: Secret<String>,
+        name: String,
+        connector_recipient_id: Option<RecipientIdType>,
+    },
+}
+
+#[derive(Debug, Clone, serde::Deserialize, serde::Serialize, ToSchema)]
+pub enum MerchantRecipientData {
+    #[schema(value_type= Option<String>)]
+    ConnectorRecipientId(Secret<String>),
+    #[schema(value_type= Option<String>)]
+    WalletId(Secret<String>),
+    AccountData(MerchantAccountData),
 }
 
 // Different patterns of authentication.
@@ -805,6 +850,9 @@ pub struct MerchantConnectorResponse {
 
     #[schema(value_type = ConnectorStatus, example = "inactive")]
     pub status: api_enums::ConnectorStatus,
+
+    #[schema(value_type = Option<AdditionalMerchantData>)]
+    pub additional_merchant_data: Option<pii::SecretSerdeValue>,
 }
 
 /// Create a new Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc."

crates/common_enums/src/enums.rs

@@ -176,6 +176,7 @@ pub enum RoutableConnectors {
     Worldline,
     Worldpay,
     Zen,
+    Plaid,
     Zsl,
 }
 

crates/diesel_models/src/merchant_connector_account.rs

@@ -44,6 +44,7 @@ pub struct MerchantConnectorAccount {
     pub pm_auth_config: Option<serde_json::Value>,
     pub status: storage_enums::ConnectorStatus,
     pub connector_wallets_details: Option<Encryption>,
+    pub additional_merchant_data: Option<Encryption>,
 }
 
 #[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
@@ -74,6 +75,7 @@ pub struct MerchantConnectorAccountNew {
     pub pm_auth_config: Option<serde_json::Value>,
     pub status: storage_enums::ConnectorStatus,
     pub connector_wallets_details: Option<Encryption>,
+    pub additional_merchant_data: Option<Encryption>,
 }
 
 #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]

crates/diesel_models/src/schema.rs

@@ -707,6 +707,7 @@ diesel::table! {
         applepay_verified_domains -> Nullable<Array<Nullable<Text>>>,
         pm_auth_config -> Nullable<Jsonb>,
         status -> ConnectorStatus,
+        additional_merchant_data -> Nullable<Bytea>,
         connector_wallets_details -> Nullable<Bytea>,
     }
 }

crates/kgraph_utils/benches/evaluation.rs

@@ -71,6 +71,7 @@ fn build_test_data(
         applepay_verified_domains: None,
         pm_auth_config: None,
         status: api_enums::ConnectorStatus::Inactive,
+        additional_merchant_data: None,
     };
     let config = CountryCurrencyFilter {
         connector_configs: HashMap::new(),

crates/kgraph_utils/src/mca.rs

@@ -759,6 +759,7 @@ mod tests {
             applepay_verified_domains: None,
             pm_auth_config: None,
             status: api_enums::ConnectorStatus::Inactive,
+            additional_merchant_data: None,
         };
 
         let config_map = kgraph_types::CountryCurrencyFilter {

crates/openapi/src/openapi.rs

@@ -256,6 +256,10 @@ Never share your secret api keys. Keep them guarded and secure.
         api_models::enums::AuthorizationStatus,
         api_models::enums::PaymentMethodStatus,
         api_models::admin::MerchantConnectorCreate,
+        api_models::admin::AdditionalMerchantData,
+        api_models::admin::MerchantRecipientData,
+        api_models::admin::MerchantAccountData,
+        api_models::admin::RecipientIdType,
         api_models::admin::MerchantConnectorUpdate,
         api_models::admin::PrimaryBusinessDetails,
         api_models::admin::FrmConfigs,