feat(core): billing_details inclusion in Payment Intent

crates/api_models/src/payments.rs

@@ -2933,7 +2933,9 @@ impl Address {
 
 // used by customers also, could be moved outside
 /// Address details
-#[derive(Clone, Default, Debug, Eq, serde::Deserialize, serde::Serialize, PartialEq, ToSchema)]
+#[derive(
+    Clone, Default, Debug, Eq, serde::Deserialize, serde::Serialize, Setter, PartialEq, ToSchema,
+)]
 #[serde(deny_unknown_fields)]
 pub struct AddressDetails {
     /// The address city

crates/diesel_models/src/payment_intent.rs

@@ -59,6 +59,7 @@ pub struct PaymentIntent {
     pub request_external_three_ds_authentication: Option<bool>,
     pub charges: Option<pii::SecretSerdeValue>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
+    pub billing_address_details: Option<Encryption>,
     pub customer_details: Option<Encryption>,
 }
 
@@ -115,6 +116,7 @@ pub struct PaymentIntentNew {
     pub request_external_three_ds_authentication: Option<bool>,
     pub charges: Option<pii::SecretSerdeValue>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
+    pub billing_address_details: Option<Encryption>,
     pub customer_details: Option<Encryption>,
 }
 
@@ -175,6 +177,7 @@ pub enum PaymentIntentUpdate {
         request_external_three_ds_authentication: Option<bool>,
         frm_metadata: Option<pii::SecretSerdeValue>,
         customer_details: Option<Encryption>,
+        billing_address_details: Option<Encryption>,
     },
     PaymentAttemptAndAttemptCountUpdate {
         active_attempt_id: String,
@@ -250,6 +253,7 @@ pub struct PaymentIntentUpdateInternal {
     pub fingerprint_id: Option<String>,
     pub request_external_three_ds_authentication: Option<bool>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
+    pub billing_address_details: Option<Encryption>,
     pub customer_details: Option<Encryption>,
 }
 
@@ -286,6 +290,7 @@ impl PaymentIntentUpdate {
             fingerprint_id,
             request_external_three_ds_authentication,
             frm_metadata,
+            billing_address_details,
             customer_details,
         } = self.into();
         PaymentIntent {
@@ -324,6 +329,7 @@ impl PaymentIntentUpdate {
             request_external_three_ds_authentication: request_external_three_ds_authentication
                 .or(source.request_external_three_ds_authentication),
             frm_metadata: frm_metadata.or(source.frm_metadata),
+            billing_address_details: billing_address_details.or(source.billing_address_details),
             customer_details: customer_details.or(source.customer_details),
             ..source
         }
@@ -356,6 +362,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_address_details,
             } => Self {
                 amount: Some(amount),
                 currency: Some(currency),
@@ -380,6 +387,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_address_details,
                 ..Default::default()
             },
             PaymentIntentUpdate::MetadataUpdate {

crates/diesel_models/src/schema.rs

@@ -889,6 +889,7 @@ diesel::table! {
         charges -> Nullable<Jsonb>,
         frm_metadata -> Nullable<Jsonb>,
         customer_details -> Nullable<Bytea>,
+        billing_address_details -> Nullable<Bytea>,
     }
 }
 

crates/hyperswitch_domain_models/src/payments.rs

@@ -62,5 +62,6 @@ pub struct PaymentIntent {
     pub request_external_three_ds_authentication: Option<bool>,
     pub charges: Option<pii::SecretSerdeValue>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
+    pub billing_address_details: Option<Encryptable<Secret<serde_json::Value>>>,
     pub customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
 }

crates/hyperswitch_domain_models/src/payments/payment_attempt.rs

@@ -529,6 +529,7 @@ impl behaviour::Conversion for PaymentIntent {
             request_external_three_ds_authentication: self.request_external_three_ds_authentication,
             charges: self.charges,
             frm_metadata: self.frm_metadata,
+            billing_address_details: self.billing_address_details.map(Encryption::from),
             customer_details: self.customer_details.map(Encryption::from),
         })
     }
@@ -587,6 +588,10 @@ impl behaviour::Conversion for PaymentIntent {
                     .request_external_three_ds_authentication,
                 charges: storage_model.charges,
                 frm_metadata: storage_model.frm_metadata,
+                billing_address_details: storage_model
+                    .billing_address_details
+                    .async_lift(inner_decrypt)
+                    .await?,
                 customer_details: storage_model
                     .customer_details
                     .async_lift(inner_decrypt)
@@ -644,6 +649,7 @@ impl behaviour::Conversion for PaymentIntent {
             request_external_three_ds_authentication: self.request_external_three_ds_authentication,
             charges: self.charges,
             frm_metadata: self.frm_metadata,
+            billing_address_details: self.billing_address_details.map(Encryption::from),
             customer_details: self.customer_details.map(Encryption::from),
         })
     }

crates/hyperswitch_domain_models/src/payments/payment_intent.rs

@@ -133,6 +133,7 @@ pub struct PaymentIntentNew {
     pub session_expiry: Option<PrimitiveDateTime>,
     pub request_external_three_ds_authentication: Option<bool>,
     pub charges: Option<pii::SecretSerdeValue>,
+    pub billing_address_details: Option<Encryptable<Secret<serde_json::Value>>>,
     pub customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
 }
 
@@ -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_address_details: Option<Encryptable<Secret<serde_json::Value>>>,
     },
     PaymentAttemptAndAttemptCountUpdate {
         active_attempt_id: String,
@@ -269,6 +271,7 @@ pub struct PaymentIntentUpdateInternal {
     pub session_expiry: Option<PrimitiveDateTime>,
     pub request_external_three_ds_authentication: Option<bool>,
     pub frm_metadata: Option<pii::SecretSerdeValue>,
+    pub billing_address_details: Option<Encryptable<Secret<serde_json::Value>>>,
     pub customer_details: Option<Encryptable<Secret<serde_json::Value>>>,
 }
 
@@ -298,6 +301,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_address_details,
             } => Self {
                 amount: Some(amount),
                 currency: Some(currency),
@@ -322,6 +326,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_address_details,
                 ..Default::default()
             },
             PaymentIntentUpdate::MetadataUpdate {
@@ -562,6 +567,7 @@ impl From<PaymentIntentUpdate> for DieselPaymentIntentUpdate {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details,
+                billing_address_details,
             } => Self::Update {
                 amount,
                 currency,
@@ -585,6 +591,7 @@ impl From<PaymentIntentUpdate> for DieselPaymentIntentUpdate {
                 request_external_three_ds_authentication,
                 frm_metadata,
                 customer_details: customer_details.map(Encryption::from),
+                billing_address_details: billing_address_details.map(Encryption::from),
             },
             PaymentIntentUpdate::PaymentAttemptAndAttemptCountUpdate {
                 active_attempt_id,
@@ -686,6 +693,7 @@ impl From<PaymentIntentUpdateInternal> for diesel_models::PaymentIntentUpdateInt
             fingerprint_id,
             request_external_three_ds_authentication,
             frm_metadata,
+            billing_address_details,
             customer_details,
         } = value;
 
@@ -720,6 +728,7 @@ impl From<PaymentIntentUpdateInternal> for diesel_models::PaymentIntentUpdateInt
             fingerprint_id,
             request_external_three_ds_authentication,
             frm_metadata,
+            billing_address_details: billing_address_details.map(Encryption::from),
             customer_details: customer_details.map(Encryption::from),
         }
     }

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

@@ -3121,6 +3121,7 @@ mod tests {
             request_external_three_ds_authentication: None,
             charges: None,
             frm_metadata: None,
+            billing_address_details: None,
             customer_details: None,
         };
         let req_cs = Some("1".to_string());
@@ -3181,6 +3182,7 @@ mod tests {
             request_external_three_ds_authentication: None,
             charges: None,
             frm_metadata: None,
+            billing_address_details: None,
             customer_details: None,
         };
         let req_cs = Some("1".to_string());
@@ -3240,6 +3242,7 @@ mod tests {
             request_external_three_ds_authentication: None,
             charges: None,
             frm_metadata: None,
+            billing_address_details: None,
             customer_details: 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,
@@ -1213,6 +1214,9 @@ 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_address_details =
+            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();
@@ -1257,6 +1261,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
                         request_external_three_ds_authentication: None,
                         frm_metadata: m_frm_metadata,
                         customer_details,
+                        billing_address_details,
                     },
                     &m_key_store,
                     storage_scheme,

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

@@ -1043,6 +1043,20 @@ impl PaymentCreate {
             .change_context(errors::ApiErrorResponse::InternalServerError)?
             .map(Secret::new);
 
+        // Derivation of directly supplied Billing Address data in our Payment Create Request
+        let raw_billing_address_details = request
+            .billing
+            .clone()
+            .and_then(|billing_details| billing_details.address.clone());
+
+        // Encrypting our Billing Address Details to be stored in Payment Intent
+        let billing_address_details = raw_billing_address_details
+            .clone()
+            .async_and_then(|_| async {
+                create_encrypted_data(key_store, raw_billing_address_details.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()
@@ -1114,6 +1128,7 @@ impl PaymentCreate {
                 .request_external_three_ds_authentication,
             charges,
             frm_metadata: request.frm_metadata.clone(),
+            billing_address_details,
             customer_details,
         })
     }

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

@@ -18,6 +18,7 @@ use crate::{
     core::{
         errors::{self, CustomResult, RouterResult, StorageErrorExt},
         mandate::helpers as m_helpers,
+        payment_methods::cards::create_encrypted_data,
         payments::{self, helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
         utils as core_utils,
     },
@@ -217,6 +218,13 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
         )
         .await?;
 
+        payment_intent.billing_address_details = billing_address
+            .clone()
+            .async_and_then(|_| async {
+                create_encrypted_data(key_store, billing_address.clone()).await
+            })
+            .await;
+
         let payment_method_billing = helpers::create_or_update_address_for_payment_by_request(
             db,
             request
@@ -704,6 +712,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
         let metadata = payment_data.payment_intent.metadata.clone();
         let frm_metadata = payment_data.payment_intent.frm_metadata.clone();
         let session_expiry = payment_data.payment_intent.session_expiry;
+        let billing_address_details = payment_data.payment_intent.billing_address_details.clone();
         payment_data.payment_intent = state
             .store
             .update_payment_intent(
@@ -733,6 +742,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
                         .request_external_three_ds_authentication,
                     frm_metadata,
                     customer_details,
+                    billing_address_details,
                 },
                 key_store,
                 storage_scheme,

crates/router/src/services/kafka/payment_intent.rs

@@ -1,6 +1,7 @@
-use common_utils::{id_type, types::MinorUnit};
+use common_utils::{crypto::Encryptable, id_type, types::MinorUnit};
 use diesel_models::enums as storage_enums;
 use hyperswitch_domain_models::payments::PaymentIntent;
+use masking::Secret;
 use time::OffsetDateTime;
 
 #[derive(serde::Serialize, Debug)]
@@ -31,6 +32,7 @@ pub struct KafkaPaymentIntent<'a> {
     pub business_label: Option<&'a String>,
     pub attempt_count: i16,
     pub payment_confirm_source: Option<storage_enums::PaymentSource>,
+    pub billing_address_details: Option<Encryptable<Secret<serde_json::Value>>>,
 }
 
 impl<'a> KafkaPaymentIntent<'a> {
@@ -59,6 +61,7 @@ impl<'a> KafkaPaymentIntent<'a> {
             business_label: intent.business_label.as_ref(),
             attempt_count: intent.attempt_count,
             payment_confirm_source: intent.payment_confirm_source,
+            billing_address_details: intent.billing_address_details.clone(),
         }
     }
 }

crates/router/src/services/kafka/payment_intent_event.rs

@@ -1,6 +1,7 @@
-use common_utils::{id_type, types::MinorUnit};
+use common_utils::{crypto::Encryptable, id_type, types::MinorUnit};
 use diesel_models::enums as storage_enums;
 use hyperswitch_domain_models::payments::PaymentIntent;
+use masking::Secret;
 use time::OffsetDateTime;
 
 #[serde_with::skip_serializing_none]
@@ -32,6 +33,7 @@ pub struct KafkaPaymentIntentEvent<'a> {
     pub business_label: Option<&'a String>,
     pub attempt_count: i16,
     pub payment_confirm_source: Option<storage_enums::PaymentSource>,
+    pub billing_address_details: Option<Encryptable<Secret<serde_json::Value>>>,
 }
 
 impl<'a> KafkaPaymentIntentEvent<'a> {
@@ -60,6 +62,7 @@ impl<'a> KafkaPaymentIntentEvent<'a> {
             business_label: intent.business_label.as_ref(),
             attempt_count: intent.attempt_count,
             payment_confirm_source: intent.payment_confirm_source,
+            billing_address_details: intent.billing_address_details.clone(),
         }
     }
 }

crates/router/src/utils/user/sample_data.rs

@@ -225,6 +225,7 @@ pub async fn generate_sample_data(
             request_external_three_ds_authentication: None,
             charges: None,
             frm_metadata: Default::default(),
+            billing_address_details: None,
             customer_details: None,
         };
         let payment_attempt = PaymentAttemptBatchNew {

migrations/2024-06-23-200642_add_billing_address_details_in_payment_intent/down.sql

@@ -0,0 +1,2 @@
+-- This file should undo anything in `up.sql`
+ALTER TABLE payment_intent DROP COLUMN IF EXISTS billing_address_details;

migrations/2024-06-23-200642_add_billing_address_details_in_payment_intent/up.sql

@@ -0,0 +1,2 @@
+-- Your SQL goes here
+ALTER TABLE payment_intent ADD COLUMN IF NOT EXISTS billing_address_details BYTEA DEFAULT NULL;