refactor(core): updated payments response with payment_method_id & payment_method_status

crates/api_models/src/payments.rs

@@ -2717,6 +2717,13 @@ pub struct PaymentsResponse {
 
     /// Payment Fingerprint
     pub fingerprint: Option<String>,
+
+    /// Payment Method Id
+    pub payment_method_id: Option<String>,
+
+    /// Payment Method Status
+    #[schema(value_type = Option<PaymentMethodStatus>)]
+    pub payment_method_status: Option<common_enums::PaymentMethodStatus>,
 }
 
 #[derive(Setter, Clone, Default, Debug, PartialEq, serde::Serialize, ToSchema)]

crates/common_enums/src/enums.rs

@@ -1205,6 +1205,36 @@ pub enum PaymentMethodStatus {
     Processing,
 }
 
+impl From<AttemptStatus> for PaymentMethodStatus {
+    fn from(attempt_status: AttemptStatus) -> Self {
+        match attempt_status {
+            AttemptStatus::Charged | AttemptStatus::Authorized => Self::Active,
+            AttemptStatus::Failure => Self::Inactive,
+            AttemptStatus::Voided
+            | AttemptStatus::Started
+            | AttemptStatus::Pending
+            | AttemptStatus::Unresolved
+            | AttemptStatus::CodInitiated
+            | AttemptStatus::Authorizing
+            | AttemptStatus::VoidInitiated
+            | AttemptStatus::AuthorizationFailed
+            | AttemptStatus::RouterDeclined
+            | AttemptStatus::AuthenticationSuccessful
+            | AttemptStatus::PaymentMethodAwaited
+            | AttemptStatus::AuthenticationFailed
+            | AttemptStatus::AuthenticationPending
+            | AttemptStatus::CaptureInitiated
+            | AttemptStatus::CaptureFailed
+            | AttemptStatus::VoidFailed
+            | AttemptStatus::AutoRefunded
+            | AttemptStatus::PartialCharged
+            | AttemptStatus::PartialChargedAndChargeable
+            | AttemptStatus::ConfirmationAwaited
+            | AttemptStatus::DeviceDataCollectionPending => Self::Processing,
+        }
+    }
+}
+
 /// To indicate the type of payment experience that the customer would go through
 #[derive(
     Eq,

crates/data_models/src/payments/payment_attempt.rs

@@ -323,6 +323,7 @@ pub enum PaymentAttemptUpdate {
         authentication_id: Option<String>,
         payment_method_billing_address_id: Option<String>,
         fingerprint_id: Option<String>,
+        payment_method_id: Option<String>,
     },
     RejectUpdate {
         status: storage_enums::AttemptStatus,

crates/diesel_models/src/payment_attempt.rs

@@ -226,6 +226,7 @@ pub enum PaymentAttemptUpdate {
         fingerprint_id: Option<String>,
         updated_by: String,
         merchant_connector_id: Option<String>,
+        payment_method_id: Option<String>,
         external_three_ds_authentication_attempted: Option<bool>,
         authentication_connector: Option<String>,
         authentication_id: Option<String>,
@@ -574,6 +575,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
                 authentication_id,
                 payment_method_billing_address_id,
                 fingerprint_id,
+                payment_method_id,
             } => Self {
                 amount: Some(amount),
                 currency: Some(currency),
@@ -601,6 +603,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
                 authentication_id,
                 payment_method_billing_address_id,
                 fingerprint_id,
+                payment_method_id: payment_method_id.map(Some),
                 ..Default::default()
             },
             PaymentAttemptUpdate::VoidUpdate {

crates/openapi/src/openapi.rs

@@ -229,6 +229,7 @@ Never share your secret api keys. Keep them guarded and secure.
         api_models::enums::ReconStatus,
         api_models::enums::ConnectorStatus,
         api_models::enums::AuthorizationStatus,
+        api_models::enums::PaymentMethodStatus,
         api_models::admin::MerchantConnectorCreate,
         api_models::admin::MerchantConnectorUpdate,
         api_models::admin::PrimaryBusinessDetails,

crates/router/src/core/authentication/transformers.rs

@@ -170,6 +170,7 @@ pub fn construct_router_data<F: Clone, Req, Res>(
         frm_metadata: None,
         dispute_id: None,
         refund_id: None,
+        payment_method_status: None,
     })
 }
 

crates/router/src/core/fraud_check/flows/checkout_flow.rs

@@ -64,6 +64,7 @@ impl ConstructFlowSpecificData<frm_api::Checkout, FraudCheckCheckoutData, FraudC
             description: None,
             return_url: None,
             payment_method_id: None,
+            payment_method_status: None,
             address: self.address.clone(),
             auth_type: storage_enums::AuthenticationType::NoThreeDs,
             connector_meta_data: None,

crates/router/src/core/fraud_check/flows/fulfillment_flow.rs

@@ -76,6 +76,7 @@ pub async fn construct_fulfillment_router_data<'a>(
         auth_type: payment_attempt.authentication_type.unwrap_or_default(),
         connector_meta_data: merchant_connector_account.get_metadata(),
         amount_captured: payment_intent.amount_captured,
+        payment_method_status: None,
         request: FraudCheckFulfillmentData {
             amount: payment_attempt.amount,
             order_details: payment_intent.order_details.clone(),

crates/router/src/core/fraud_check/flows/record_return.rs

@@ -84,6 +84,7 @@ impl ConstructFlowSpecificData<RecordReturn, FraudCheckRecordReturnData, FraudCh
             payment_method_token: None,
             connector_customer: None,
             preprocessing_id: None,
+            payment_method_status: None,
             connector_request_reference_id: uuid::Uuid::new_v4().to_string(),
             test_mode: None,
             recurring_mandate_payment_data: None,

crates/router/src/core/fraud_check/flows/sale_flow.rs

@@ -80,6 +80,7 @@ impl ConstructFlowSpecificData<frm_api::Sale, FraudCheckSaleData, FraudCheckResp
             payment_method_token: None,
             connector_customer: None,
             preprocessing_id: None,
+            payment_method_status: None,
             connector_request_reference_id: uuid::Uuid::new_v4().to_string(),
             test_mode: None,
             recurring_mandate_payment_data: None,

crates/router/src/core/fraud_check/flows/transaction_flow.rs

@@ -107,6 +107,7 @@ impl
             connector_http_status_code: None,
             external_latency: None,
             connector_api_version: None,
+            payment_method_status: None,
             apple_pay_flow: None,
             frm_metadata: None,
             refund_id: None,

crates/router/src/core/mandate/utils.rs

@@ -53,6 +53,7 @@ pub async fn construct_mandate_revoke_router_data(
         preprocessing_id: None,
         payment_method_balance: None,
         connector_api_version: None,
+        payment_method_status: None,
         request: types::MandateRevokeRequestData {
             mandate_id: mandate.mandate_id,
             connector_mandate_id: mandate.connector_mandate_id,

crates/router/src/core/payment_methods.rs

@@ -13,11 +13,7 @@ use data_models::payments::{payment_attempt::PaymentAttempt, PaymentIntent};
 use diesel_models::enums;
 
 use crate::{
-    core::{
-        errors::RouterResult,
-        payments::helpers,
-        pm_auth::{self as core_pm_auth},
-    },
+    core::{errors::RouterResult, payments::helpers, pm_auth as core_pm_auth},
     routes::AppState,
     types::{
         api::{self, payments},
@@ -44,7 +40,7 @@ pub trait PaymentMethodRetrieve {
         payment_intent: &PaymentIntent,
         card_token_data: Option<&CardToken>,
         customer: &Option<domain::Customer>,
-    ) -> RouterResult<Option<(payments::PaymentMethodData, enums::PaymentMethod)>>;
+    ) -> RouterResult<storage::PaymentMethodDataWithId>;
 }
 
 #[async_trait::async_trait]
@@ -128,8 +124,8 @@ impl PaymentMethodRetrieve for Oss {
         payment_intent: &PaymentIntent,
         card_token_data: Option<&CardToken>,
         customer: &Option<domain::Customer>,
-    ) -> RouterResult<Option<(payments::PaymentMethodData, enums::PaymentMethod)>> {
-        match token_data {
+    ) -> RouterResult<storage::PaymentMethodDataWithId> {
+        let token = match token_data {
             storage::PaymentTokenData::TemporaryGeneric(generic_token) => {
                 helpers::retrieve_payment_method_with_temporary_token(
                     state,
@@ -138,7 +134,15 @@ impl PaymentMethodRetrieve for Oss {
                     merchant_key_store,
                     card_token_data,
                 )
-                .await
+                .await?
+                .map(
+                    |(payment_method_data, payment_method)| storage::PaymentMethodDataWithId {
+                        payment_method_data: Some(payment_method_data),
+                        payment_method: Some(payment_method),
+                        payment_method_id: None,
+                    },
+                )
+                .unwrap_or_default()
             }
 
             storage::PaymentTokenData::Temporary(generic_token) => {
@@ -149,7 +153,15 @@ impl PaymentMethodRetrieve for Oss {
                     merchant_key_store,
                     card_token_data,
                 )
-                .await
+                .await?
+                .map(
+                    |(payment_method_data, payment_method)| storage::PaymentMethodDataWithId {
+                        payment_method_data: Some(payment_method_data),
+                        payment_method: Some(payment_method),
+                        payment_method_id: None,
+                    },
+                )
+                .unwrap_or_default()
             }
 
             storage::PaymentTokenData::Permanent(card_token) => {
@@ -164,7 +176,21 @@ impl PaymentMethodRetrieve for Oss {
                     card_token_data,
                 )
                 .await
-                .map(|card| Some((card, enums::PaymentMethod::Card)))
+                .map(|card| Some((card, enums::PaymentMethod::Card)))?
+                .map(
+                    |(payment_method_data, payment_method)| storage::PaymentMethodDataWithId {
+                        payment_method_data: Some(payment_method_data),
+                        payment_method: Some(payment_method),
+                        payment_method_id: Some(
+                            card_token
+                                .payment_method_id
+                                .as_ref()
+                                .unwrap_or(&card_token.token)
+                                .to_string(),
+                        ),
+                    },
+                )
+                .unwrap_or_default()
             }
 
             storage::PaymentTokenData::PermanentCard(card_token) => {
@@ -179,7 +205,21 @@ impl PaymentMethodRetrieve for Oss {
                     card_token_data,
                 )
                 .await
-                .map(|card| Some((card, enums::PaymentMethod::Card)))
+                .map(|card| Some((card, enums::PaymentMethod::Card)))?
+                .map(
+                    |(payment_method_data, payment_method)| storage::PaymentMethodDataWithId {
+                        payment_method_data: Some(payment_method_data),
+                        payment_method: Some(payment_method),
+                        payment_method_id: Some(
+                            card_token
+                                .payment_method_id
+                                .as_ref()
+                                .unwrap_or(&card_token.token)
+                                .to_string(),
+                        ),
+                    },
+                )
+                .unwrap_or_default()
             }
 
             storage::PaymentTokenData::AuthBankDebit(auth_token) => {
@@ -190,10 +230,23 @@ impl PaymentMethodRetrieve for Oss {
                     payment_intent,
                     customer,
                 )
-                .await
+                .await?
+                .map(
+                    |(payment_method_data, payment_method)| storage::PaymentMethodDataWithId {
+                        payment_method_data: Some(payment_method_data),
+                        payment_method: Some(payment_method),
+                        payment_method_id: None,
+                    },
+                )
+                .unwrap_or_default()
             }
 
-            storage::PaymentTokenData::WalletToken(_) => Ok(None),
-        }
+            storage::PaymentTokenData::WalletToken(_) => storage::PaymentMethodDataWithId {
+                payment_method: None,
+                payment_method_data: None,
+                payment_method_id: None,
+            },
+        };
+        Ok(token)
     }
 }

crates/router/src/core/payments.rs

@@ -261,6 +261,7 @@ where
                         None,
                     )
                     .await?;
+
                     let operation = Box::new(PaymentResponse);
 
                     connector_http_status_code = router_data.connector_http_status_code;
@@ -1927,7 +1928,7 @@ where
 
             let connector_tokenization_action = match payment_method_action {
                 TokenizationAction::TokenizeInRouter => {
-                    let (_operation, payment_method_data) = operation
+                    let (_operation, payment_method_data, pm_id) = operation
                         .to_domain()?
                         .make_pm_data(
                             state,
@@ -1938,12 +1939,14 @@ where
                         )
                         .await?;
                     payment_data.payment_method_data = payment_method_data;
+                    payment_data.payment_attempt.payment_method_id = pm_id;
+
                     TokenizationAction::SkipConnectorTokenization
                 }
 
                 TokenizationAction::TokenizeInConnector => TokenizationAction::TokenizeInConnector,
                 TokenizationAction::TokenizeInConnectorAndRouter => {
-                    let (_operation, payment_method_data) = operation
+                    let (_operation, payment_method_data, pm_id) = operation
                         .to_domain()?
                         .make_pm_data(
                             state,
@@ -1955,6 +1958,7 @@ where
                         .await?;
 
                     payment_data.payment_method_data = payment_method_data;
+                    payment_data.payment_attempt.payment_method_id = pm_id;
                     TokenizationAction::TokenizeInConnector
                 }
                 TokenizationAction::ConnectorToken(token) => {
@@ -1996,7 +2000,7 @@ where
 {
     // On confirm is false and only router related
     let payment_data = if !is_operation_confirm(operation) {
-        let (_operation, payment_method_data) = operation
+        let (_operation, payment_method_data, pm_id) = operation
             .to_domain()?
             .make_pm_data(
                 state,
@@ -2007,6 +2011,7 @@ where
             )
             .await?;
         payment_data.payment_method_data = payment_method_data;
+        payment_data.payment_attempt.payment_method_id = pm_id;
         payment_data
     } else {
         payment_data
@@ -2078,6 +2083,7 @@ where
     pub authorizations: Vec<diesel_models::authorization::Authorization>,
     pub authentication: Option<(storage::Authentication, AuthenticationData)>,
     pub frm_metadata: Option<serde_json::Value>,
+    pub payment_method_status: Option<common_enums::PaymentMethodStatus>,
 }
 
 #[derive(Debug, Default, Clone)]