feat(payments_v2): add logic to render required_fields in response of payment_method list (#8317)

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

Author: Sakilmostak

api-reference/v2/openapi_spec_v2.json

@@ -22286,7 +22286,8 @@
             "type": "object",
             "required": [
               "payment_method_type",
-              "payment_method_subtype"
+              "payment_method_subtype",
+              "required_fields"
             ],
             "properties": {
               "payment_method_type": {
@@ -22304,12 +22305,7 @@
                 "nullable": true
               },
               "required_fields": {
-                "allOf": [
-                  {
-                    "$ref": "#/components/schemas/RequiredFieldInfo"
-                  }
-                ],
-                "nullable": true
+                "$ref": "#/components/schemas/RequiredFieldInfo"
               },
               "surcharge_details": {
                 "allOf": [

crates/api_models/src/payments.rs

@@ -7720,8 +7720,8 @@ pub struct ResponsePaymentMethodTypesForPayments {
 
     /// Required fields for the payment_method_type.
     /// This is the union of all the required fields for the payment method type enabled in all the connectors.
-    #[schema(value_type = Option<RequiredFieldInfo>)]
-    pub required_fields: Option<Vec<payment_methods::RequiredFieldInfo>>,
+    #[schema(value_type = RequiredFieldInfo)]
+    pub required_fields: Vec<payment_methods::RequiredFieldInfo>,
 
     /// surcharge details for this payment method type if exists
     #[schema(value_type = Option<SurchargeDetailsResponse>)]

crates/router/src/core/payments/payment_methods.rs

@@ -5,7 +5,9 @@ use common_utils::{ext_traits::OptionExt, id_type};
 use error_stack::ResultExt;
 
 use super::errors;
-use crate::{core::payment_methods, db::errors::StorageErrorExt, routes, types::domain};
+use crate::{
+    configs::settings, core::payment_methods, db::errors::StorageErrorExt, routes, types::domain,
+};
 
 #[cfg(feature = "v2")]
 pub async fn list_payment_methods(
@@ -57,7 +59,7 @@ pub async fn list_payment_methods(
     let response =
         hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled::from_payment_connectors_list(payment_connector_accounts)
             .perform_filtering()
-            .get_required_fields(RequiredFieldsInput::new())
+            .get_required_fields(RequiredFieldsInput::new(state.conf.required_fields.clone()))
             .perform_surcharge_calculation()
             .generate_response(customer_payment_methods);
 
@@ -67,11 +69,41 @@ pub async fn list_payment_methods(
 }
 
 /// Container for the inputs required for the required fields
-struct RequiredFieldsInput {}
+struct RequiredFieldsInput {
+    required_fields_config: settings::RequiredFields,
+}
 
 impl RequiredFieldsInput {
-    fn new() -> Self {
-        Self {}
+    fn new(required_fields_config: settings::RequiredFields) -> Self {
+        Self {
+            required_fields_config,
+        }
+    }
+}
+
+trait GetRequiredFields {
+    fn get_required_fields(
+        &self,
+        payment_method_enabled: &hyperswitch_domain_models::merchant_connector_account::PaymentMethodsEnabledForConnector,
+    ) -> Option<&settings::RequiredFieldFinal>;
+}
+
+impl GetRequiredFields for settings::RequiredFields {
+    fn get_required_fields(
+        &self,
+        payment_method_enabled: &hyperswitch_domain_models::merchant_connector_account::PaymentMethodsEnabledForConnector,
+    ) -> Option<&settings::RequiredFieldFinal> {
+        self.0
+            .get(&payment_method_enabled.payment_method)
+            .and_then(|required_fields_for_payment_method| {
+                required_fields_for_payment_method.0.get(
+                    &payment_method_enabled
+                        .payment_methods_enabled
+                        .payment_method_subtype,
+                )
+            })
+            .map(|connector_fields| &connector_fields.fields)
+            .and_then(|connector_hashmap| connector_hashmap.get(&payment_method_enabled.connector))
     }
 }
 
@@ -83,23 +115,50 @@ struct FilteredPaymentMethodsEnabled(
 impl FilteredPaymentMethodsEnabled {
     fn get_required_fields(
         self,
-        _input: RequiredFieldsInput,
+        input: RequiredFieldsInput,
     ) -> RequiredFieldsForEnabledPaymentMethodTypes {
+        let required_fields_config = input.required_fields_config;
+
         let required_fields_info = self
             .0
             .into_iter()
-            .map(
-                |payment_methods_enabled| RequiredFieldsForEnabledPaymentMethod {
-                    required_field: None,
+            .map(|payment_methods_enabled| {
+                let required_fields =
+                    required_fields_config.get_required_fields(&payment_methods_enabled);
+
+                let required_fields = required_fields
+                    .map(|required_fields| {
+                        let common_required_fields = required_fields
+                            .common
+                            .iter()
+                            .flatten()
+                            .map(ToOwned::to_owned);
+
+                        // Collect mandate required fields because this is for zero auth mandates only
+                        let mandate_required_fields = required_fields
+                            .mandate
+                            .iter()
+                            .flatten()
+                            .map(ToOwned::to_owned);
+
+                        // Combine both common and mandate required fields
+                        common_required_fields
+                            .chain(mandate_required_fields)
+                            .collect::<Vec<_>>()
+                    })
+                    .unwrap_or_default();
+
+                RequiredFieldsForEnabledPaymentMethod {
+                    required_fields,
                     payment_method_type: payment_methods_enabled.payment_method,
                     payment_method_subtype: payment_methods_enabled
                         .payment_methods_enabled
                         .payment_method_subtype,
                     payment_experience: payment_methods_enabled
                         .payment_methods_enabled
                         .payment_experience,
-                },
-            )
+                }
+            })
             .collect();
 
         RequiredFieldsForEnabledPaymentMethodTypes(required_fields_info)
@@ -108,7 +167,7 @@ impl FilteredPaymentMethodsEnabled {
 
 /// Element container to hold the filtered payment methods with required fields
 struct RequiredFieldsForEnabledPaymentMethod {
-    required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>,
+    required_fields: Vec<api_models::payment_methods::RequiredFieldInfo>,
     payment_method_subtype: common_enums::PaymentMethodType,
     payment_method_type: common_enums::PaymentMethod,
     payment_experience: Option<common_enums::PaymentExperience>,
@@ -119,7 +178,7 @@ struct RequiredFieldsForEnabledPaymentMethodTypes(Vec<RequiredFieldsForEnabledPa
 
 /// Element Container to hold the filtered payment methods enabled with required fields and surcharge
 struct RequiredFieldsAndSurchargeForEnabledPaymentMethodType {
-    required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>,
+    required_fields: Vec<api_models::payment_methods::RequiredFieldInfo>,
     payment_method_subtype: common_enums::PaymentMethodType,
     payment_method_type: common_enums::PaymentMethod,
     payment_experience: Option<common_enums::PaymentExperience>,
@@ -146,7 +205,7 @@ impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes {
                     payment_method_type: payment_methods_enabled.payment_method_type,
                     payment_method_subtype: payment_methods_enabled.payment_method_subtype,
                     payment_experience: payment_methods_enabled.payment_experience,
-                    required_fields: payment_methods_enabled.required_field,
+                    required_fields: payment_methods_enabled.required_fields,
                     surcharge_details: payment_methods_enabled.surcharge,
                     extra_information: None,
                 }
@@ -170,7 +229,7 @@ impl RequiredFieldsForEnabledPaymentMethodTypes {
             .map(
                 |payment_methods_enabled| RequiredFieldsAndSurchargeForEnabledPaymentMethodType {
                     payment_method_type: payment_methods_enabled.payment_method_type,
-                    required_field: payment_methods_enabled.required_field,
+                    required_fields: payment_methods_enabled.required_fields,
                     payment_method_subtype: payment_methods_enabled.payment_method_subtype,
                     payment_experience: payment_methods_enabled.payment_experience,
                     surcharge: None,