Merge branch 'main' into surcharge-genration-for-saved-card

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/payments.rs

@@ -203,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
@@ -735,12 +736,16 @@ impl Card {
     }
 }
 
-#[derive(Eq, PartialEq, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)]
+#[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)]
@@ -2246,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)]
@@ -2314,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
@@ -3022,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

crates/api_models/src/user.rs

@@ -7,13 +7,25 @@ pub mod dashboard_metadata;
 pub mod sample_data;
 
 #[derive(serde::Deserialize, Debug, Clone, serde::Serialize)]
-pub struct ConnectAccountRequest {
+pub struct SignUpWithMerchantIdRequest {
+    pub name: Secret<String>,
+    pub email: pii::Email,
+    pub password: Secret<String>,
+    pub company_name: String,
+}
+
+pub type SignUpWithMerchantIdResponse = AuthorizeResponse;
+
+#[derive(serde::Deserialize, Debug, Clone, serde::Serialize)]
+pub struct SignUpRequest {
     pub email: pii::Email,
     pub password: Secret<String>,
 }
 
+pub type SignUpResponse = DashboardEntryResponse;
+
 #[derive(serde::Serialize, Debug, Clone)]
-pub struct ConnectAccountResponse {
+pub struct DashboardEntryResponse {
     pub token: Secret<String>,
     pub merchant_id: String,
     pub name: Secret<String>,
@@ -25,6 +37,28 @@ pub struct ConnectAccountResponse {
     pub user_id: String,
 }
 
+pub type SignInRequest = SignUpRequest;
+
+pub type SignInResponse = DashboardEntryResponse;
+
+#[derive(serde::Deserialize, Debug, Clone, serde::Serialize)]
+pub struct ConnectAccountRequest {
+    pub email: pii::Email,
+}
+
+pub type ConnectAccountResponse = AuthorizeResponse;
+
+#[derive(serde::Serialize, Debug, Clone)]
+pub struct AuthorizeResponse {
+    pub is_email_sent: bool,
+    //this field is added for audit/debug reasons
+    #[serde(skip_serializing)]
+    pub user_id: String,
+    //this field is added for audit/debug reasons
+    #[serde(skip_serializing)]
+    pub merchant_id: String,
+}
+
 #[derive(serde::Deserialize, Debug, serde::Serialize)]
 pub struct ChangePasswordRequest {
     pub new_password: Secret<String>,
@@ -36,6 +70,8 @@ pub struct SwitchMerchantIdRequest {
     pub merchant_id: String,
 }
 
+pub type SwitchMerchantResponse = DashboardEntryResponse;
+
 #[derive(serde::Deserialize, Debug, serde::Serialize)]
 pub struct CreateInternalUserRequest {
     pub name: Secret<String>,

crates/common_enums/src/enums.rs

@@ -246,6 +246,32 @@ pub enum CaptureStatus {
     Failed,
 }
 
+#[derive(
+    Default,
+    Clone,
+    Debug,
+    Eq,
+    PartialEq,
+    serde::Deserialize,
+    serde::Serialize,
+    strum::Display,
+    strum::EnumString,
+    ToSchema,
+    Hash,
+)]
+#[router_derive::diesel_enum(storage_type = "text")]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum AuthorizationStatus {
+    Success,
+    Failure,
+    // Processing state is before calling connector
+    #[default]
+    Processing,
+    // Requires merchant action
+    Unresolved,
+}
+
 #[derive(
     Clone,
     Copy,

crates/common_utils/src/request.rs

@@ -17,6 +17,7 @@ pub enum Method {
     Post,
     Put,
     Delete,
+    Patch,
 }
 
 #[derive(Deserialize, Serialize, Debug)]

crates/data_models/src/payments.rs

@@ -52,4 +52,5 @@ pub struct PaymentIntent {
     pub surcharge_applicable: Option<bool>,
     pub request_incremental_authorization: storage_enums::RequestIncrementalAuthorization,
     pub incremental_authorization_allowed: Option<bool>,
+    pub authorization_count: Option<i32>,
 }

crates/data_models/src/payments/payment_attempt.rs

@@ -359,6 +359,10 @@ pub enum PaymentAttemptUpdate {
         connector: Option<String>,
         updated_by: String,
     },
+    IncrementalAuthorizationAmountUpdate {
+        amount: i64,
+        amount_capturable: i64,
+    },
 }
 
 impl ForeignIDRef for PaymentAttempt {

crates/data_models/src/payments/payment_intent.rs

@@ -109,6 +109,7 @@ pub struct PaymentIntentNew {
     pub surcharge_applicable: Option<bool>,
     pub request_incremental_authorization: storage_enums::RequestIncrementalAuthorization,
     pub incremental_authorization_allowed: Option<bool>,
+    pub authorization_count: Option<i32>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -186,6 +187,12 @@ pub enum PaymentIntentUpdate {
         surcharge_applicable: bool,
         updated_by: String,
     },
+    IncrementalAuthorizationAmountUpdate {
+        amount: i64,
+    },
+    AuthorizationCountUpdate {
+        authorization_count: i32,
+    },
 }
 
 #[derive(Clone, Debug, Default)]
@@ -218,6 +225,7 @@ pub struct PaymentIntentUpdateInternal {
     pub updated_by: String,
     pub surcharge_applicable: Option<bool>,
     pub incremental_authorization_allowed: Option<bool>,
+    pub authorization_count: Option<i32>,
 }
 
 impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
@@ -381,6 +389,16 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 updated_by,
                 ..Default::default()
             },
+            PaymentIntentUpdate::IncrementalAuthorizationAmountUpdate { amount } => Self {
+                amount: Some(amount),
+                ..Default::default()
+            },
+            PaymentIntentUpdate::AuthorizationCountUpdate {
+                authorization_count,
+            } => Self {
+                authorization_count: Some(authorization_count),
+                ..Default::default()
+            },
         }
     }
 }

crates/diesel_models/src/authorization.rs

@@ -0,0 +1,78 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::incremental_authorization};
+
+#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, Serialize, Deserialize, Hash)]
+#[diesel(table_name = incremental_authorization)]
+#[diesel(primary_key(authorization_id, merchant_id))]
+pub struct Authorization {
+    pub authorization_id: String,
+    pub merchant_id: String,
+    pub payment_id: String,
+    pub amount: i64,
+    #[serde(with = "common_utils::custom_serde::iso8601")]
+    pub created_at: PrimitiveDateTime,
+    #[serde(with = "common_utils::custom_serde::iso8601")]
+    pub modified_at: PrimitiveDateTime,
+    pub status: storage_enums::AuthorizationStatus,
+    pub error_code: Option<String>,
+    pub error_message: Option<String>,
+    pub connector_authorization_id: Option<String>,
+    pub previously_authorized_amount: i64,
+}
+
+#[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay, Serialize, Deserialize)]
+#[diesel(table_name = incremental_authorization)]
+pub struct AuthorizationNew {
+    pub authorization_id: String,
+    pub merchant_id: String,
+    pub payment_id: String,
+    pub amount: i64,
+    pub status: storage_enums::AuthorizationStatus,
+    pub error_code: Option<String>,
+    pub error_message: Option<String>,
+    pub connector_authorization_id: Option<String>,
+    pub previously_authorized_amount: i64,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum AuthorizationUpdate {
+    StatusUpdate {
+        status: storage_enums::AuthorizationStatus,
+        error_code: Option<String>,
+        error_message: Option<String>,
+        connector_authorization_id: Option<String>,
+    },
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = incremental_authorization)]
+pub struct AuthorizationUpdateInternal {
+    pub status: Option<storage_enums::AuthorizationStatus>,
+    pub error_code: Option<String>,
+    pub error_message: Option<String>,
+    pub modified_at: Option<PrimitiveDateTime>,
+    pub connector_authorization_id: Option<String>,
+}
+
+impl From<AuthorizationUpdate> for AuthorizationUpdateInternal {
+    fn from(authorization_child_update: AuthorizationUpdate) -> Self {
+        let now = Some(common_utils::date_time::now());
+        match authorization_child_update {
+            AuthorizationUpdate::StatusUpdate {
+                status,
+                error_code,
+                error_message,
+                connector_authorization_id,
+            } => Self {
+                status: Some(status),
+                error_code,
+                error_message,
+                connector_authorization_id,
+                modified_at: now,
+            },
+        }
+    }
+}