feat(core): billing_details inclusion in Payment Intent (#5090)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

crates/diesel_models/src/payment_intent.rs

@@ -60,6 +60,7 @@ pub struct PaymentIntent {
     pub charges: Option<pii::SecretSerdeValue>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
     pub customer_details: Option<Encryption>,
+    pub billing_details: Option<Encryption>,
     pub merchant_order_reference_id: Option<String>,
 }
 
@@ -117,6 +118,7 @@ pub struct PaymentIntentNew {
     pub charges: Option<pii::SecretSerdeValue>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
     pub customer_details: Option<Encryption>,
+    pub billing_details: Option<Encryption>,
     pub merchant_order_reference_id: Option<String>,
 }
 
@@ -177,6 +179,7 @@ pub enum PaymentIntentUpdate {
         request_external_three_ds_authentication: Option<bool>,
         frm_metadata: Option<pii::SecretSerdeValue>,
         customer_details: Option<Encryption>,
+        billing_details: Option<Encryption>,
         merchant_order_reference_id: Option<String>,
     },
     PaymentAttemptAndAttemptCountUpdate {
@@ -254,6 +257,7 @@ pub struct PaymentIntentUpdateInternal {
     pub request_external_three_ds_authentication: Option<bool>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
     pub customer_details: Option<Encryption>,
+    pub billing_details: Option<Encryption>,
     pub merchant_order_reference_id: Option<String>,
 }
 
@@ -291,6 +295,7 @@ impl PaymentIntentUpdate {
             request_external_three_ds_authentication,
             frm_metadata,
             customer_details,
+            billing_details,
             merchant_order_reference_id,
         } = self.into();
         PaymentIntent {
@@ -330,6 +335,7 @@ impl PaymentIntentUpdate {
                 .or(source.request_external_three_ds_authentication),
             frm_metadata: frm_metadata.or(source.frm_metadata),
             customer_details: customer_details.or(source.customer_details),
+            billing_details: billing_details.or(source.billing_details),
             merchant_order_reference_id: merchant_order_reference_id
                 .or(source.merchant_order_reference_id),
             ..source
@@ -363,6 +369,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_details,
                 merchant_order_reference_id,
             } => Self {
                 amount: Some(amount),
@@ -388,6 +395,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_details,
                 merchant_order_reference_id,
                 ..Default::default()
             },

crates/diesel_models/src/schema.rs

@@ -890,6 +890,7 @@ diesel::table! {
         charges -> Nullable<Jsonb>,
         frm_metadata -> Nullable<Jsonb>,
         customer_details -> Nullable<Bytea>,
+        billing_details -> Nullable<Bytea>,
         #[max_length = 255]
         merchant_order_reference_id -> Nullable<Varchar>,
     }

crates/hyperswitch_domain_models/src/payments.rs

@@ -63,5 +63,6 @@ pub struct PaymentIntent {
     pub charges: Option<pii::SecretSerdeValue>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
     pub customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
+    pub billing_details: Option<Encryptable<Secret<serde_json::Value>>>,
     pub merchant_order_reference_id: Option<String>,
 }

crates/hyperswitch_domain_models/src/payments/payment_attempt.rs

@@ -530,6 +530,7 @@ impl behaviour::Conversion for PaymentIntent {
             charges: self.charges,
             frm_metadata: self.frm_metadata,
             customer_details: self.customer_details.map(Encryption::from),
+            billing_details: self.billing_details.map(Encryption::from),
             merchant_order_reference_id: self.merchant_order_reference_id,
         })
     }
@@ -592,6 +593,10 @@ impl behaviour::Conversion for PaymentIntent {
                     .customer_details
                     .async_lift(inner_decrypt)
                     .await?,
+                billing_details: storage_model
+                    .billing_details
+                    .async_lift(inner_decrypt)
+                    .await?,
                 merchant_order_reference_id: storage_model.merchant_order_reference_id,
             })
         }
@@ -647,6 +652,7 @@ impl behaviour::Conversion for PaymentIntent {
             charges: self.charges,
             frm_metadata: self.frm_metadata,
             customer_details: self.customer_details.map(Encryption::from),
+            billing_details: self.billing_details.map(Encryption::from),
             merchant_order_reference_id: self.merchant_order_reference_id,
         })
     }

crates/hyperswitch_domain_models/src/payments/payment_intent.rs

@@ -134,6 +134,7 @@ pub struct PaymentIntentNew {
     pub request_external_three_ds_authentication: Option<bool>,
     pub charges: Option<pii::SecretSerdeValue>,
     pub customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
+    pub billing_details: Option<Encryptable<Secret<serde_json::Value>>>,
 }
 
 #[derive(Debug, Clone, Serialize)]
@@ -193,6 +194,7 @@ pub enum PaymentIntentUpdate {
         session_expiry: Option<PrimitiveDateTime>,
         request_external_three_ds_authentication: Option<bool>,
         customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
+        billing_details: Option<Encryptable<Secret<serde_json::Value>>>,
         merchant_order_reference_id: Option<String>,
     },
     PaymentAttemptAndAttemptCountUpdate {
@@ -271,6 +273,7 @@ pub struct PaymentIntentUpdateInternal {
     pub request_external_three_ds_authentication: Option<bool>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
     pub customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
+    pub billing_details: Option<Encryptable<Secret<serde_json::Value>>>,
     pub merchant_order_reference_id: Option<String>,
 }
 
@@ -300,6 +303,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_details,
                 merchant_order_reference_id,
             } => Self {
                 amount: Some(amount),
@@ -325,6 +329,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_details,
                 merchant_order_reference_id,
                 ..Default::default()
             },
@@ -566,6 +571,7 @@ impl From<PaymentIntentUpdate> for DieselPaymentIntentUpdate {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_details,
                 merchant_order_reference_id,
             } => Self::Update {
                 amount,
@@ -590,6 +596,7 @@ impl From<PaymentIntentUpdate> for DieselPaymentIntentUpdate {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details: customer_details.map(Encryption::from),
+                billing_details: billing_details.map(Encryption::from),
                 merchant_order_reference_id,
             },
             PaymentIntentUpdate::PaymentAttemptAndAttemptCountUpdate {
@@ -693,6 +700,7 @@ impl From<PaymentIntentUpdateInternal> for diesel_models::PaymentIntentUpdateInt
             request_external_three_ds_authentication,
             frm_metadata,
             customer_details,
+            billing_details,
             merchant_order_reference_id,
         } = value;
 
@@ -728,6 +736,7 @@ impl From<PaymentIntentUpdateInternal> for diesel_models::PaymentIntentUpdateInt
             request_external_three_ds_authentication,
             frm_metadata,
             customer_details: customer_details.map(Encryption::from),
+            billing_details: billing_details.map(Encryption::from),
             merchant_order_reference_id,
         }
     }

crates/router/src/connector/rapyd/transformers.rs

@@ -151,7 +151,7 @@ impl TryFrom<&RapydRouterData<&types::PaymentsAuthorizeRouterData>> for RapydPay
             }
             _ => None,
         }
-        .get_required_value("payment_method not implemnted")
+        .get_required_value("payment_method not implemented")
         .change_context(errors::ConnectorError::NotImplemented(
             "payment_method".to_owned(),
         ))?;

crates/router/src/connector/utils.rs

@@ -341,7 +341,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.first_name.clone())
+                    .and_then(|billing_details| billing_details.first_name.clone())
             })
             .ok_or_else(missing_field_err(
                 "payment_method_data.billing.address.first_name",
@@ -364,7 +364,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.last_name.clone())
+                    .and_then(|billing_details| billing_details.last_name.clone())
             })
             .ok_or_else(missing_field_err(
                 "payment_method_data.billing.address.last_name",
@@ -378,7 +378,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.line1.clone())
+                    .and_then(|billing_details| billing_details.line1.clone())
             })
             .ok_or_else(missing_field_err(
                 "payment_method_data.billing.address.line1",
@@ -391,7 +391,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.city)
+                    .and_then(|billing_details| billing_details.city)
             })
             .ok_or_else(missing_field_err(
                 "payment_method_data.billing.address.city",
@@ -421,7 +421,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.line1)
+                    .and_then(|billing_details| billing_details.line1)
             })
     }
 
@@ -432,7 +432,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.line2)
+                    .and_then(|billing_details| billing_details.line2)
             })
     }
 
@@ -443,7 +443,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.city)
+                    .and_then(|billing_details| billing_details.city)
             })
     }
 
@@ -454,7 +454,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.country)
+                    .and_then(|billing_details| billing_details.country)
             })
     }
 
@@ -465,7 +465,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.zip)
+                    .and_then(|billing_details| billing_details.zip)
             })
     }
 
@@ -476,7 +476,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.state)
+                    .and_then(|billing_details| billing_details.state)
             })
     }
 
@@ -487,7 +487,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.first_name)
+                    .and_then(|billing_details| billing_details.first_name)
             })
     }
 
@@ -498,7 +498,7 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
                 billing_address
                     .clone()
                     .address
-                    .and_then(|billing_address_details| billing_address_details.last_name)
+                    .and_then(|billing_details| billing_details.last_name)
             })
     }
 
@@ -615,7 +615,7 @@ impl AddressData for api::Address {
     fn get_optional_country(&self) -> Option<enums::CountryAlpha2> {
         self.address
             .as_ref()
-            .and_then(|billing_address_details| billing_address_details.country)
+            .and_then(|billing_details| billing_details.country)
     }
 
     fn get_optional_full_name(&self) -> Option<Secret<String>> {

crates/router/src/core/payments/helpers.rs

@@ -3151,6 +3151,7 @@ mod tests {
             charges: None,
             frm_metadata: None,
             customer_details: None,
+            billing_details: None,
             merchant_order_reference_id: None,
         };
         let req_cs = Some("1".to_string());
@@ -3212,6 +3213,7 @@ mod tests {
             charges: None,
             frm_metadata: None,
             customer_details: None,
+            billing_details: None,
             merchant_order_reference_id: None,
         };
         let req_cs = Some("1".to_string());
@@ -3272,6 +3274,7 @@ mod tests {
             charges: None,
             frm_metadata: None,
             customer_details: None,
+            billing_details: None,
             merchant_order_reference_id: None,
         };
         let req_cs = Some("1".to_string());

crates/router/src/core/payments/operations/payment_confirm.rs

@@ -22,6 +22,7 @@ use crate::{
         blocklist::utils as blocklist_utils,
         errors::{self, CustomResult, RouterResult, StorageErrorExt},
         mandate::helpers as m_helpers,
+        payment_methods::cards::create_encrypted_data,
         payments::{
             self, helpers, operations, populate_surcharge_details, CustomerDetails, PaymentAddress,
             PaymentData,
@@ -1218,6 +1219,10 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
             .in_current_span(),
         );
 
+        let billing_address = payment_data.address.get_payment_billing();
+        let billing_details = billing_address
+            .async_and_then(|_| async { create_encrypted_data(key_store, billing_address).await })
+            .await;
         let m_payment_data_payment_intent = payment_data.payment_intent.clone();
         let m_customer_id = customer_id.clone();
         let m_shipping_address_id = shipping_address_id.clone();
@@ -1263,6 +1268,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
                         frm_metadata: m_frm_metadata,
                         customer_details,
                         merchant_order_reference_id: None,
+                        billing_details,
                     },
                     &m_key_store,
                     storage_scheme,

crates/router/src/core/payments/operations/payment_create.rs

@@ -1045,6 +1045,16 @@ impl PaymentCreate {
             .change_context(errors::ApiErrorResponse::InternalServerError)?
             .map(Secret::new);
 
+        // Derivation of directly supplied Billing Address data in our Payment Create Request
+        // Encrypting our Billing Address Details to be stored in Payment Intent
+        let billing_details = request
+            .billing
+            .clone()
+            .async_and_then(|_| async {
+                create_encrypted_data(key_store, request.billing.clone()).await
+            })
+            .await;
+
         // Derivation of directly supplied Customer data in our Payment Create Request
         let raw_customer_details = if request.customer_id.is_none()
             && (request.name.is_some()
@@ -1116,6 +1126,7 @@ impl PaymentCreate {
                 .request_external_three_ds_authentication,
             charges,
             frm_metadata: request.frm_metadata.clone(),
+            billing_details,
             customer_details,
             merchant_order_reference_id: request.merchant_order_reference_id.clone(),
         })