feat(core): payments overcapture support for V1

api-reference-v2/openapi_spec.json

@@ -12397,6 +12397,22 @@
           }
         }
       },
+      "OverCaptureRequest": {
+        "type": "string",
+        "description": "Whether overcapture is requested or not",
+        "enum": [
+          "enable",
+          "skip"
+        ]
+      },
+      "OverCaptureStatus": {
+        "type": "string",
+        "description": "Whether overcapture is allowed by the connector",
+        "enum": [
+          "applicable",
+          "not_applicable"
+        ]
+      },
       "PayLaterData": {
         "oneOf": [
           {
@@ -15476,6 +15492,14 @@
             "type": "string",
             "description": "Connector Identifier for the payment method",
             "nullable": true
+          },
+          "overcapture_status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureStatus"
+              }
+            ],
+            "nullable": true
           }
         }
       },
@@ -16376,6 +16400,14 @@
             "type": "string",
             "description": "Connector Identifier for the payment method",
             "nullable": true
+          },
+          "overcapture_status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureStatus"
+              }
+            ],
+            "nullable": true
           }
         }
       },

api-reference/openapi_spec.json

@@ -15517,6 +15517,22 @@
           }
         }
       },
+      "OverCaptureRequest": {
+        "type": "string",
+        "description": "Whether overcapture is requested or not",
+        "enum": [
+          "enable",
+          "skip"
+        ]
+      },
+      "OverCaptureStatus": {
+        "type": "string",
+        "description": "Whether overcapture is allowed by the connector",
+        "enum": [
+          "applicable",
+          "not_applicable"
+        ]
+      },
       "PayLaterData": {
         "oneOf": [
           {
@@ -17904,6 +17920,14 @@
               }
             ],
             "nullable": true
+          },
+          "request_overcapture": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureRequest"
+              }
+            ],
+            "nullable": true
           }
         }
       },
@@ -18297,6 +18321,14 @@
               }
             ],
             "nullable": true
+          },
+          "request_overcapture": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureRequest"
+              }
+            ],
+            "nullable": true
           }
         }
       },
@@ -18836,6 +18868,14 @@
             "type": "string",
             "description": "Connector Identifier for the payment method",
             "nullable": true
+          },
+          "overcapture_status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureStatus"
+              }
+            ],
+            "nullable": true
           }
         }
       },
@@ -19514,6 +19554,14 @@
               }
             ],
             "nullable": true
+          },
+          "request_overcapture": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureRequest"
+              }
+            ],
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -20079,6 +20127,14 @@
             "type": "string",
             "description": "Connector Identifier for the payment method",
             "nullable": true
+          },
+          "overcapture_status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureStatus"
+              }
+            ],
+            "nullable": true
           }
         }
       },
@@ -20570,6 +20626,14 @@
               }
             ],
             "nullable": true
+          },
+          "request_overcapture": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OverCaptureRequest"
+              }
+            ],
+            "nullable": true
           }
         }
       },
@@ -22536,6 +22600,11 @@
             "type": "object",
             "description": "Product authentication ids",
             "nullable": true
+          },
+          "always_request_overcapture": {
+            "type": "boolean",
+            "description": "Indicates if the overcapture is always requested or not.",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -22777,6 +22846,13 @@
             "type": "object",
             "description": "Product authentication ids",
             "nullable": true
+          },
+          "always_request_overcapture": {
+            "type": "boolean",
+            "description": "Indicates if the overcapture is always requested or not.",
+            "default": false,
+            "example": false,
+            "nullable": true
           }
         }
       },

crates/api_models/src/admin.rs

@@ -1864,6 +1864,10 @@ pub struct ProfileCreate {
     /// Product authentication ids
     #[schema(value_type = Option<Object>, example = r#"{ "key1": "value-1", "key2": "value-2" }"#)]
     pub authentication_product_ids: Option<HashMap<String, id_type::MerchantConnectorAccountId>>,
+
+    /// Indicates if the overcapture is always requested or not.
+    #[serde(default)]
+    pub always_request_overcapture: Option<bool>,
 }
 
 #[nutype::nutype(
@@ -2117,6 +2121,10 @@ pub struct ProfileResponse {
     /// Product authentication ids
     #[schema(value_type = Option<Object>, example = r#"{ "key1": "value-1", "key2": "value-2" }"#)]
     pub authentication_product_ids: Option<serde_json::Value>,
+
+    /// Indicates if the overcapture is always requested or not.
+    #[schema(default = false, example = false)]
+    pub always_request_overcapture: Option<bool>,
 }
 
 #[cfg(feature = "v2")]
@@ -2370,6 +2378,10 @@ pub struct ProfileUpdate {
     /// Product authentication ids
     #[schema(value_type = Option<Object>, example = r#"{ "key1": "value-1", "key2": "value-2" }"#)]
     pub authentication_product_ids: Option<HashMap<String, id_type::MerchantConnectorAccountId>>,
+
+    /// Indicates if the overcapture is always requested or not.
+    #[schema(default = false, example = false)]
+    pub always_request_overcapture: Option<bool>,
 }
 
 #[cfg(feature = "v2")]

crates/api_models/src/payments.rs

@@ -1034,6 +1034,10 @@ pub struct PaymentsRequest {
     /// Service details for click to pay external authentication
     #[schema(value_type = Option<CtpServiceDetails>)]
     pub ctp_service_details: Option<CtpServiceDetails>,
+
+    /// Whether to request overcapture on this payment
+    #[schema(value_type = Option<OverCaptureRequest>)]
+    pub request_overcapture: Option<api_enums::OverCaptureRequest>,
 }
 
 #[derive(Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize, ToSchema)]
@@ -4746,6 +4750,10 @@ pub struct PaymentsResponse {
 
     /// Connector Identifier for the payment method
     pub connector_mandate_id: Option<String>,
+
+    /// Whether the payment is overcaptureable or not
+    #[schema(value_type = Option<OverCaptureStatus>)]
+    pub overcapture_status: Option<common_enums::OverCaptureStatus>,
 }
 
 // Serialize is implemented because, this will be serialized in the api events.

crates/common_enums/Cargo.toml

@@ -13,7 +13,7 @@ openapi = []
 payouts = []
 
 [dependencies]
-diesel = { version = "2.2.3", features = ["postgres"] }
+diesel = { version = "2.2.3", features = ["postgres", "128-column-tables"]}
 serde = { version = "1.0.197", features = ["derive"] }
 serde_json = "1.0.115"
 strum = { version = "0.26", features = ["derive"] }

crates/common_enums/src/enums.rs

@@ -3379,6 +3379,60 @@ pub enum External3dsAuthenticationRequest {
     Skip,
 }
 
+/// Whether overcapture is requested or not
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Default,
+    Eq,
+    Hash,
+    PartialEq,
+    ToSchema,
+    serde::Deserialize,
+    serde::Serialize,
+    strum::Display,
+    strum::EnumIter,
+    strum::EnumString,
+)]
+#[router_derive::diesel_enum(storage_type = "text")]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum OverCaptureRequest {
+    /// Request for applying overcapture
+    Enable,
+    /// Skip overcapture
+    #[default]
+    Skip,
+}
+
+/// Whether overcapture is allowed by the connector
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Default,
+    Eq,
+    Hash,
+    PartialEq,
+    ToSchema,
+    serde::Deserialize,
+    serde::Serialize,
+    strum::Display,
+    strum::EnumIter,
+    strum::EnumString,
+)]
+#[router_derive::diesel_enum(storage_type = "text")]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum OverCaptureStatus {
+    /// Overcapture is allowed
+    Applicable,
+    /// Overcapture is not allowed
+    #[default]
+    NotApplicable,
+}
+
 /// Whether payment link is requested to be enabled or not for this transaction
 #[derive(Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize, Default, ToSchema)]
 pub enum EnablePaymentLinkRequest {

crates/common_enums/src/transformers.rs

@@ -2021,6 +2021,44 @@ impl super::External3dsAuthenticationRequest {
     }
 }
 
+impl From<bool> for super::OverCaptureRequest {
+    fn from(value: bool) -> Self {
+        match value {
+            true => Self::Enable,
+            _ => Self::Skip,
+        }
+    }
+}
+
+/// Get the boolean value of the `OverCaptureRequest`.
+impl super::OverCaptureRequest {
+    pub fn as_bool(&self) -> bool {
+        match self {
+            Self::Enable => true,
+            Self::Skip => false,
+        }
+    }
+}
+
+impl From<Option<bool>> for super::OverCaptureStatus {
+    fn from(value: Option<bool>) -> Self {
+        match value {
+            Some(true) => Self::Applicable,
+            _ => Self::NotApplicable,
+        }
+    }
+}
+
+/// Get the boolean value of the `OverCaptureStatus`.
+impl super::OverCaptureStatus {
+    pub fn as_bool(&self) -> bool {
+        match self {
+            Self::Applicable => true,
+            Self::NotApplicable => false,
+        }
+    }
+}
+
 impl super::EnablePaymentLinkRequest {
     pub fn as_bool(&self) -> bool {
         match self {

crates/diesel_models/Cargo.toml

@@ -17,7 +17,7 @@ payment_methods_v2 = []
 
 [dependencies]
 async-bb8-diesel = { git = "https://github.com/jarnura/async-bb8-diesel", rev = "53b4ab901aab7635c8215fd1c2d542c8db443094" }
-diesel = { version = "2.2.3", features = ["postgres", "serde_json", "time", "64-column-tables"] }
+diesel = { version = "2.2.3", features = ["postgres", "serde_json", "time", "128-column-tables"] }
 error-stack = "0.4.1"
 rustc-hash = "1.1.0"
 serde = { version = "1.0.197", features = ["derive"] }