Merge branch 'main' into connector_transaction_id/cybersource

crates/api_models/src/events/payment.rs

@@ -8,8 +8,9 @@ use crate::{
     payments::{
         PaymentIdType, PaymentListConstraints, PaymentListFilterConstraints, PaymentListFilters,
         PaymentListResponse, PaymentListResponseV2, PaymentsApproveRequest, PaymentsCancelRequest,
-        PaymentsCaptureRequest, PaymentsRejectRequest, PaymentsRequest, PaymentsResponse,
-        PaymentsRetrieveRequest, PaymentsStartRequest, RedirectionResponse,
+        PaymentsCaptureRequest, PaymentsIncrementalAuthorizationRequest, PaymentsRejectRequest,
+        PaymentsRequest, PaymentsResponse, PaymentsRetrieveRequest, PaymentsStartRequest,
+        RedirectionResponse,
     },
 };
 impl ApiEventMetric for PaymentsRetrieveRequest {
@@ -149,3 +150,11 @@ impl ApiEventMetric for PaymentListResponseV2 {
 }
 
 impl ApiEventMetric for RedirectionResponse {}
+
+impl ApiEventMetric for PaymentsIncrementalAuthorizationRequest {
+    fn get_api_event_type(&self) -> Option<ApiEventsType> {
+        Some(ApiEventsType::Payment {
+            payment_id: self.payment_id.clone(),
+        })
+    }
+}

crates/api_models/src/events/user.rs

@@ -6,11 +6,12 @@ use crate::user::{
     dashboard_metadata::{
         GetMetaDataRequest, GetMetaDataResponse, GetMultipleMetaDataPayload, SetMetaDataRequest,
     },
-    ChangePasswordRequest, ConnectAccountRequest, ConnectAccountResponse,
-    CreateInternalUserRequest, GetUsersResponse, SwitchMerchantIdRequest, UserMerchantCreate,
+    AuthorizeResponse, ChangePasswordRequest, ConnectAccountRequest, CreateInternalUserRequest,
+    DashboardEntryResponse, GetUsersResponse, SignUpRequest, SignUpWithMerchantIdRequest,
+    SwitchMerchantIdRequest, UserMerchantCreate,
 };
 
-impl ApiEventMetric for ConnectAccountResponse {
+impl ApiEventMetric for DashboardEntryResponse {
     fn get_api_event_type(&self) -> Option<ApiEventsType> {
         Some(ApiEventsType::User {
             merchant_id: self.merchant_id.clone(),
@@ -19,9 +20,9 @@ impl ApiEventMetric for ConnectAccountResponse {
     }
 }
 
-impl ApiEventMetric for ConnectAccountRequest {}
-
 common_utils::impl_misc_api_event_type!(
+    SignUpRequest,
+    SignUpWithMerchantIdRequest,
     ChangePasswordRequest,
     GetMultipleMetaDataPayload,
     GetMetaDataResponse,
@@ -30,7 +31,9 @@ common_utils::impl_misc_api_event_type!(
     SwitchMerchantIdRequest,
     CreateInternalUserRequest,
     UserMerchantCreate,
-    GetUsersResponse
+    GetUsersResponse,
+    AuthorizeResponse,
+    ConnectAccountRequest
 );
 
 #[cfg(feature = "dummy_connector")]

crates/api_models/src/payment_methods.rs

@@ -2,8 +2,10 @@ use std::collections::HashMap;
 
 use cards::CardNumber;
 use common_utils::{
-    consts::SURCHARGE_PERCENTAGE_PRECISION_LENGTH, crypto::OptionalEncryptableName, pii,
-    types::Percentage,
+    consts::SURCHARGE_PERCENTAGE_PRECISION_LENGTH,
+    crypto::OptionalEncryptableName,
+    pii,
+    types::{Percentage, Surcharge},
 };
 use serde::de;
 use utoipa::ToSchema;
@@ -14,7 +16,7 @@ use crate::{
     admin,
     customers::CustomerId,
     enums as api_enums,
-    payments::{self, BankCodeResponse, RequestSurchargeDetails},
+    payments::{self, BankCodeResponse},
 };
 
 #[derive(Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)]
@@ -337,117 +339,13 @@ pub struct SurchargeDetailsResponse {
     /// tax on surcharge value
     pub tax_on_surcharge: Option<Percentage<SURCHARGE_PERCENTAGE_PRECISION_LENGTH>>,
     /// surcharge amount for this payment
-    pub surcharge_amount: i64,
+    pub display_surcharge_amount: f64,
     /// tax on surcharge amount for this payment
-    pub tax_on_surcharge_amount: i64,
+    pub display_tax_on_surcharge_amount: f64,
+    /// sum of display_surcharge_amount and display_tax_on_surcharge_amount
+    pub display_total_surcharge_amount: f64,
     /// sum of original amount,
-    pub final_amount: i64,
-}
-
-impl SurchargeDetailsResponse {
-    pub fn is_request_surcharge_matching(
-        &self,
-        request_surcharge_details: RequestSurchargeDetails,
-    ) -> bool {
-        request_surcharge_details.surcharge_amount == self.surcharge_amount
-            && request_surcharge_details.tax_amount.unwrap_or(0) == self.tax_on_surcharge_amount
-    }
-    pub fn get_total_surcharge_amount(&self) -> i64 {
-        self.surcharge_amount + self.tax_on_surcharge_amount
-    }
-}
-
-#[derive(Clone, Debug)]
-pub struct SurchargeMetadata {
-    surcharge_results: HashMap<
-        (
-            common_enums::PaymentMethod,
-            common_enums::PaymentMethodType,
-            Option<common_enums::CardNetwork>,
-        ),
-        SurchargeDetailsResponse,
-    >,
-    pub payment_attempt_id: String,
-}
-
-impl SurchargeMetadata {
-    pub fn new(payment_attempt_id: String) -> Self {
-        Self {
-            surcharge_results: HashMap::new(),
-            payment_attempt_id,
-        }
-    }
-    pub fn is_empty_result(&self) -> bool {
-        self.surcharge_results.is_empty()
-    }
-    pub fn get_surcharge_results_size(&self) -> usize {
-        self.surcharge_results.len()
-    }
-    pub fn insert_surcharge_details(
-        &mut self,
-        payment_method: &common_enums::PaymentMethod,
-        payment_method_type: &common_enums::PaymentMethodType,
-        card_network: Option<&common_enums::CardNetwork>,
-        surcharge_details: SurchargeDetailsResponse,
-    ) {
-        let key = (
-            payment_method.to_owned(),
-            payment_method_type.to_owned(),
-            card_network.cloned(),
-        );
-        self.surcharge_results.insert(key, surcharge_details);
-    }
-    pub fn get_surcharge_details(
-        &self,
-        payment_method: &common_enums::PaymentMethod,
-        payment_method_type: &common_enums::PaymentMethodType,
-        card_network: Option<&common_enums::CardNetwork>,
-    ) -> Option<&SurchargeDetailsResponse> {
-        let key = &(
-            payment_method.to_owned(),
-            payment_method_type.to_owned(),
-            card_network.cloned(),
-        );
-        self.surcharge_results.get(key)
-    }
-    pub fn get_surcharge_metadata_redis_key(payment_attempt_id: &str) -> String {
-        format!("surcharge_metadata_{}", payment_attempt_id)
-    }
-    pub fn get_individual_surcharge_key_value_pairs(
-        &self,
-    ) -> Vec<(String, SurchargeDetailsResponse)> {
-        self.surcharge_results
-            .iter()
-            .map(|((pm, pmt, card_network), surcharge_details)| {
-                let key =
-                    Self::get_surcharge_details_redis_hashset_key(pm, pmt, card_network.as_ref());
-                (key, surcharge_details.to_owned())
-            })
-            .collect()
-    }
-    pub fn get_surcharge_details_redis_hashset_key(
-        payment_method: &common_enums::PaymentMethod,
-        payment_method_type: &common_enums::PaymentMethodType,
-        card_network: Option<&common_enums::CardNetwork>,
-    ) -> String {
-        if let Some(card_network) = card_network {
-            format!(
-                "{}_{}_{}",
-                payment_method, payment_method_type, card_network
-            )
-        } else {
-            format!("{}_{}", payment_method, payment_method_type)
-        }
-    }
-}
-
-#[derive(Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize, ToSchema)]
-#[serde(rename_all = "snake_case", tag = "type", content = "value")]
-pub enum Surcharge {
-    /// Fixed Surcharge value
-    Fixed(i64),
-    /// Surcharge percentage
-    Rate(Percentage<SURCHARGE_PERCENTAGE_PRECISION_LENGTH>),
+    pub display_final_amount: f64,
 }
 
 /// Required fields info used while listing the payment_method_data

crates/api_models/src/payments.rs

@@ -16,7 +16,6 @@ use crate::{
     admin, disputes,
     enums::{self as api_enums},
     ephemeral_key::EphemeralKeyCreateResponse,
-    payment_methods::{Surcharge, SurchargeDetailsResponse},
     refunds,
 };
 
@@ -204,8 +203,9 @@ pub struct PaymentsRequest {
     #[schema(example = "187282ab-40ef-47a9-9206-5099ba31e432")]
     pub payment_token: Option<String>,
 
-    /// This is used when payment is to be confirmed and the card is not saved
-    #[schema(value_type = Option<String>)]
+    /// This is used when payment is to be confirmed and the card is not saved.
+    /// This field will be deprecated soon, use the CardToken object instead
+    #[schema(value_type = Option<String>, deprecated)]
     pub card_cvc: Option<Secret<String>>,
 
     /// The shipping address for the payment
@@ -339,17 +339,6 @@ impl RequestSurchargeDetails {
     pub fn is_surcharge_zero(&self) -> bool {
         self.surcharge_amount == 0 && self.tax_amount.unwrap_or(0) == 0
     }
-    pub fn get_surcharge_details_object(&self, original_amount: i64) -> SurchargeDetailsResponse {
-        let surcharge_amount = self.surcharge_amount;
-        let tax_on_surcharge_amount = self.tax_amount.unwrap_or(0);
-        SurchargeDetailsResponse {
-            surcharge: Surcharge::Fixed(self.surcharge_amount),
-            tax_on_surcharge: None,
-            surcharge_amount,
-            tax_on_surcharge_amount,
-            final_amount: original_amount + surcharge_amount + tax_on_surcharge_amount,
-        }
-    }
     pub fn get_total_surcharge_amount(&self) -> i64 {
         self.surcharge_amount + self.tax_amount.unwrap_or(0)
     }
@@ -720,12 +709,43 @@ pub struct Card {
     pub nick_name: Option<Secret<String>>,
 }
 
-#[derive(Eq, PartialEq, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)]
+impl Card {
+    fn apply_additional_card_info(&self, additional_card_info: AdditionalCardInfo) -> Self {
+        Self {
+            card_number: self.card_number.clone(),
+            card_exp_month: self.card_exp_month.clone(),
+            card_exp_year: self.card_exp_year.clone(),
+            card_holder_name: self.card_holder_name.clone(),
+            card_cvc: self.card_cvc.clone(),
+            card_issuer: self
+                .card_issuer
+                .clone()
+                .or(additional_card_info.card_issuer),
+            card_network: self
+                .card_network
+                .clone()
+                .or(additional_card_info.card_network),
+            card_type: self.card_type.clone().or(additional_card_info.card_type),
+            card_issuing_country: self
+                .card_issuing_country
+                .clone()
+                .or(additional_card_info.card_issuing_country),
+            bank_code: self.bank_code.clone().or(additional_card_info.bank_code),
+            nick_name: self.nick_name.clone(),
+        }
+    }
+}
+
+#[derive(Eq, PartialEq, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema, Default)]
 #[serde(rename_all = "snake_case")]
 pub struct CardToken {
     /// The card holder's name
     #[schema(value_type = String, example = "John Test")]
     pub card_holder_name: Option<Secret<String>>,
+
+    /// The CVC number for the card
+    #[schema(value_type = Option<String>)]
+    pub card_cvc: Option<Secret<String>>,
 }
 
 #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)]
@@ -889,6 +909,21 @@ impl PaymentMethodData {
             | Self::CardToken(_) => None,
         }
     }
+    pub fn apply_additional_payment_data(
+        &self,
+        additional_payment_data: AdditionalPaymentData,
+    ) -> Self {
+        if let AdditionalPaymentData::Card(additional_card_info) = additional_payment_data {
+            match self {
+                Self::Card(card) => {
+                    Self::Card(card.apply_additional_card_info(*additional_card_info))
+                }
+                _ => self.to_owned(),
+            }
+        } else {
+            self.to_owned()
+        }
+    }
 }
 
 pub trait GetPaymentMethodType {
@@ -2216,6 +2251,12 @@ pub struct PaymentsResponse {
 
     /// If true incremental authorization can be performed on this payment
     pub incremental_authorization_allowed: Option<bool>,
+
+    /// Total number of authorizations happened in an incremental_authorization payment
+    pub authorization_count: Option<i32>,
+
+    /// List of incremental authorizations happened to the payment
+    pub incremental_authorizations: Option<Vec<IncrementalAuthorizationResponse>>,
 }
 
 #[derive(Clone, Debug, serde::Deserialize, ToSchema, serde::Serialize)]
@@ -2284,6 +2325,24 @@ pub struct PaymentListResponse {
     // The list of payments response objects
     pub data: Vec<PaymentsResponse>,
 }
+
+#[derive(Setter, Clone, Default, Debug, PartialEq, serde::Serialize, ToSchema)]
+pub struct IncrementalAuthorizationResponse {
+    /// The unique identifier of authorization
+    pub authorization_id: String,
+    /// Amount the authorization has been made for
+    pub amount: i64,
+    #[schema(value_type= AuthorizationStatus)]
+    /// The status of the authorization
+    pub status: common_enums::AuthorizationStatus,
+    /// Error code sent by the connector for authorization
+    pub error_code: Option<String>,
+    /// Error message sent by the connector for authorization
+    pub error_message: Option<String>,
+    /// Previously authorized amount for the payment
+    pub previously_authorized_amount: i64,
+}
+
 #[derive(Clone, Debug, serde::Serialize)]
 pub struct PaymentListResponseV2 {
     /// The number of payments included in the list for given constraints
@@ -2992,6 +3051,18 @@ pub struct PaymentsCancelRequest {
     pub merchant_connector_details: Option<admin::MerchantConnectorDetailsWrap>,
 }
 
+#[derive(Default, Debug, serde::Serialize, serde::Deserialize, Clone, ToSchema)]
+pub struct PaymentsIncrementalAuthorizationRequest {
+    /// The identifier for the payment
+    #[serde(skip)]
+    pub payment_id: String,
+    /// The total amount including previously authorized amount and additional amount
+    #[schema(value_type = i64, example = 6540)]
+    pub amount: i64,
+    /// Reason for incremental authorization
+    pub reason: Option<String>,
+}
+
 #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)]
 pub struct PaymentsApproveRequest {
     /// The identifier for the payment