feat(payments_v2): implement payments capture v2 (#6722)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
juspay · Dec 20, 2024 · 977cb70 · 977cb70
1 parent 22de8ad
commit 977cb70
Show file tree

Hide file tree

Showing 22 changed files with 1,925 additions and 287 deletions.
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
@@ -6495,88 +6495,6 @@
           "greater_than_equal"
         ]
       },
-      "ConfirmIntentAmountDetailsResponse": {
-        "type": "object",
-        "required": [
-          "currency",
-          "external_tax_calculation",
-          "surcharge_calculation",
-          "net_amount",
-          "amount_capturable"
-        ],
-        "properties": {
-          "order_amount": {
-            "type": "integer",
-            "format": "int64",
-            "description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)",
-            "example": 6540,
-            "minimum": 0
-          },
-          "currency": {
-            "$ref": "#/components/schemas/Currency"
-          },
-          "shipping_cost": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MinorUnit"
-              }
-            ],
-            "nullable": true
-          },
-          "order_tax_amount": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MinorUnit"
-              }
-            ],
-            "nullable": true
-          },
-          "external_tax_calculation": {
-            "$ref": "#/components/schemas/TaxCalculationOverride"
-          },
-          "surcharge_calculation": {
-            "$ref": "#/components/schemas/SurchargeCalculationOverride"
-          },
-          "surcharge_amount": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MinorUnit"
-              }
-            ],
-            "nullable": true
-          },
-          "tax_on_surcharge": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MinorUnit"
-              }
-            ],
-            "nullable": true
-          },
-          "net_amount": {
-            "$ref": "#/components/schemas/MinorUnit"
-          },
-          "amount_to_capture": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MinorUnit"
-              }
-            ],
-            "nullable": true
-          },
-          "amount_capturable": {
-            "$ref": "#/components/schemas/MinorUnit"
-          },
-          "amount_captured": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MinorUnit"
-              }
-            ],
-            "nullable": true
-          }
-        }
-      },
       "Connector": {
         "type": "string",
         "description": "A connector is an integration to fulfill payments",
@@ -12605,6 +12523,88 @@
           }
         }
       },
+      "PaymentAmountDetailsResponse": {
+        "type": "object",
+        "required": [
+          "currency",
+          "external_tax_calculation",
+          "surcharge_calculation",
+          "net_amount",
+          "amount_capturable"
+        ],
+        "properties": {
+          "order_amount": {
+            "type": "integer",
+            "format": "int64",
+            "description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)",
+            "example": 6540,
+            "minimum": 0
+          },
+          "currency": {
+            "$ref": "#/components/schemas/Currency"
+          },
+          "shipping_cost": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MinorUnit"
+              }
+            ],
+            "nullable": true
+          },
+          "order_tax_amount": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MinorUnit"
+              }
+            ],
+            "nullable": true
+          },
+          "external_tax_calculation": {
+            "$ref": "#/components/schemas/TaxCalculationOverride"
+          },
+          "surcharge_calculation": {
+            "$ref": "#/components/schemas/SurchargeCalculationOverride"
+          },
+          "surcharge_amount": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MinorUnit"
+              }
+            ],
+            "nullable": true
+          },
+          "tax_on_surcharge": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MinorUnit"
+              }
+            ],
+            "nullable": true
+          },
+          "net_amount": {
+            "$ref": "#/components/schemas/MinorUnit"
+          },
+          "amount_to_capture": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MinorUnit"
+              }
+            ],
+            "nullable": true
+          },
+          "amount_capturable": {
+            "$ref": "#/components/schemas/MinorUnit"
+          },
+          "amount_captured": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MinorUnit"
+              }
+            ],
+            "nullable": true
+          }
+        }
+      },
       "PaymentAttemptResponse": {
         "type": "object",
         "required": [
@@ -14467,42 +14467,12 @@
       },
       "PaymentsCaptureRequest": {
         "type": "object",
-        "required": [
-          "amount_to_capture"
-        ],
         "properties": {
-          "merchant_id": {
-            "type": "string",
-            "description": "The unique identifier for the merchant",
-            "nullable": true
-          },
           "amount_to_capture": {
             "type": "integer",
             "format": "int64",
-            "description": "The Amount to be captured/ debited from the user's payment method.",
-            "example": 6540
-          },
-          "refund_uncaptured_amount": {
-            "type": "boolean",
-            "description": "Decider to refund the uncaptured amount",
-            "nullable": true
-          },
-          "statement_descriptor_suffix": {
-            "type": "string",
-            "description": "Provides information about a card payment that customers see on their statements.",
-            "nullable": true
-          },
-          "statement_descriptor_prefix": {
-            "type": "string",
-            "description": "Concatenated with the statement descriptor suffix that’s set on the account to form the complete statement descriptor.",
-            "nullable": true
-          },
-          "merchant_connector_details": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
-              }
-            ],
+            "description": "The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.",
+            "example": 6540,
             "nullable": true
           }
         }
@@ -14605,7 +14575,7 @@
             "$ref": "#/components/schemas/IntentStatus"
           },
           "amount": {
-            "$ref": "#/components/schemas/ConfirmIntentAmountDetailsResponse"
+            "$ref": "#/components/schemas/PaymentAmountDetailsResponse"
           },
           "customer_id": {
             "type": "string",
@@ -16354,7 +16324,7 @@
             "$ref": "#/components/schemas/IntentStatus"
           },
           "amount": {
-            "$ref": "#/components/schemas/ConfirmIntentAmountDetailsResponse"
+            "$ref": "#/components/schemas/PaymentAmountDetailsResponse"
           },
           "customer_id": {
             "type": "string",

diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
@@ -17372,7 +17372,7 @@
           "amount_to_capture": {
             "type": "integer",
             "format": "int64",
-            "description": "The Amount to be captured/ debited from the user's payment method.",
+            "description": "The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.",
             "example": 6540
           },
           "refund_uncaptured_amount": {

diff --git a/crates/api_models/src/events/payment.rs b/crates/api_models/src/events/payment.rs
@@ -11,7 +11,7 @@ use super::{
 ))]
 use crate::payment_methods::CustomerPaymentMethodsListResponse;
 #[cfg(all(feature = "v2", feature = "payment_methods_v2"))]
-use crate::payment_methods::CustomerPaymentMethodsListResponse;
+use crate::{events, payment_methods::CustomerPaymentMethodsListResponse};
 use crate::{
     payment_methods::{
         CustomerDefaultPaymentMethodResponse, DefaultPaymentMethod, ListCountriesCurrenciesRequest,
@@ -418,3 +418,12 @@ impl ApiEventMetric for PaymentStartRedirectionRequest {
         })
     }
 }
+
+#[cfg(feature = "v2")]
+impl ApiEventMetric for events::PaymentsCaptureResponse {
+    fn get_api_event_type(&self) -> Option<ApiEventsType> {
+        Some(ApiEventsType::Payment {
+            payment_id: self.id.clone(),
+        })
+    }
+}
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
@@ -621,7 +621,7 @@ pub struct AmountDetailsResponse {
 
 #[cfg(feature = "v2")]
 #[derive(Clone, Debug, PartialEq, serde::Serialize, ToSchema)]
-pub struct ConfirmIntentAmountDetailsResponse {
+pub struct PaymentAmountDetailsResponse {
     /// The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)
     #[schema(value_type = u64, example = 6540)]
     #[serde(default, deserialize_with = "amount::deserialize")]
@@ -4077,6 +4077,7 @@ pub struct PhoneDetails {
     pub country_code: Option<String>,
 }
 
+#[cfg(feature = "v1")]
 #[derive(Debug, Clone, Default, Eq, PartialEq, serde::Deserialize, serde::Serialize, ToSchema)]
 pub struct PaymentsCaptureRequest {
     /// The unique identifier for the payment
@@ -4085,7 +4086,7 @@ pub struct PaymentsCaptureRequest {
     /// The unique identifier for the merchant
     #[schema(value_type = Option<String>)]
     pub merchant_id: Option<id_type::MerchantId>,
-    /// The Amount to be captured/ debited from the user's payment method.
+    /// The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.
     #[schema(value_type = i64, example = 6540)]
     pub amount_to_capture: Option<MinorUnit>,
     /// Decider to refund the uncaptured amount
@@ -4099,6 +4100,28 @@ pub struct PaymentsCaptureRequest {
     pub merchant_connector_details: Option<admin::MerchantConnectorDetailsWrap>,
 }
 
+#[cfg(feature = "v2")]
+#[derive(Debug, Clone, Default, Eq, PartialEq, serde::Deserialize, serde::Serialize, ToSchema)]
+pub struct PaymentsCaptureRequest {
+    /// The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.
+    #[schema(value_type = Option<i64>, example = 6540)]
+    pub amount_to_capture: Option<MinorUnit>,
+}
+
+#[cfg(feature = "v2")]
+#[derive(Debug, Clone, serde::Serialize, ToSchema)]
+pub struct PaymentsCaptureResponse {
+    /// The unique identifier for the payment
+    pub id: id_type::GlobalPaymentId,
+
+    /// Status of the payment
+    #[schema(value_type = IntentStatus, example = "succeeded")]
+    pub status: common_enums::IntentStatus,
+
+    /// Amount details related to the payment
+    pub amount: PaymentAmountDetailsResponse,
+}
+
 #[derive(Default, Clone, Debug, Eq, PartialEq, serde::Serialize)]
 pub struct UrlDetails {
     pub url: String,
@@ -4801,7 +4824,7 @@ pub struct PaymentsConfirmIntentResponse {
     pub status: api_enums::IntentStatus,
 
     /// Amount related information for this payment and attempt
-    pub amount: ConfirmIntentAmountDetailsResponse,
+    pub amount: PaymentAmountDetailsResponse,
 
     /// The identifier for the customer
     #[schema(
@@ -4879,7 +4902,7 @@ pub struct PaymentsRetrieveResponse {
     pub status: api_enums::IntentStatus,
 
     /// Amount related information for this payment and attempt
-    pub amount: ConfirmIntentAmountDetailsResponse,
+    pub amount: PaymentAmountDetailsResponse,
 
     /// The identifier for the customer
     #[schema(

diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs
@@ -754,7 +754,6 @@ pub enum PaymentAttemptUpdate {
 #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]
 #[diesel(table_name = payment_attempt)]
 pub struct PaymentAttemptUpdateInternal {
-    // net_amount: Option<MinorUnit>,
     pub status: Option<storage_enums::AttemptStatus>,
     // authentication_type: Option<storage_enums::AuthenticationType>,
     pub error_message: Option<String>,
@@ -774,7 +773,8 @@ pub struct PaymentAttemptUpdateInternal {
     // multiple_capture_count: Option<i16>,
     // pub surcharge_amount: Option<MinorUnit>,
     // tax_on_surcharge: Option<MinorUnit>,
-    // amount_capturable: Option<MinorUnit>,
+    pub amount_capturable: Option<MinorUnit>,
+    pub amount_to_capture: Option<MinorUnit>,
     pub updated_by: String,
     pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>,
     pub connector: Option<String>,

diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs
@@ -369,6 +369,23 @@ pub struct PaymentIntentNew {
     pub split_payments: Option<common_types::payments::SplitPaymentsRequest>,
 }
 
+#[cfg(feature = "v2")]
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum PaymentIntentUpdate {
+    /// Update the payment intent details on payment intent confirmation, before calling the connector
+    ConfirmIntent {
+        status: storage_enums::IntentStatus,
+        active_attempt_id: common_utils::id_type::GlobalAttemptId,
+        updated_by: String,
+    },
+    /// Update the payment intent details on payment intent confirmation, after calling the connector
+    ConfirmIntentPostUpdate {
+        status: storage_enums::IntentStatus,
+        amount_captured: Option<MinorUnit>,
+        updated_by: String,
+    },
+}
+
 #[cfg(feature = "v1")]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub enum PaymentIntentUpdate {
@@ -514,8 +531,9 @@ pub struct PaymentIntentUpdateFields {
 #[diesel(table_name = payment_intent)]
 pub struct PaymentIntentUpdateInternal {
     pub status: Option<storage_enums::IntentStatus>,
-    pub active_attempt_id: Option<common_utils::id_type::GlobalAttemptId>,
+    pub amount_captured: Option<MinorUnit>,
     pub modified_at: PrimitiveDateTime,
+    pub active_attempt_id: Option<common_utils::id_type::GlobalAttemptId>,
     pub amount: Option<MinorUnit>,
     pub currency: Option<storage_enums::Currency>,
     pub shipping_cost: Option<MinorUnit>,