Skip to content

feat(events): Add payment metadata to hyperswitch-payment-intent-events #5170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jul 5, 2024
Merged

feat(events): Add payment metadata to hyperswitch-payment-intent-events #5170

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
50c4d2d
added payment metadata for hyperswitch-payment-intent-events
tsdk02 Jul 1, 2024
1d2e158
made clippy changes
tsdk02 Jul 1, 2024
bd2bee4
Merge branch 'main' into add-metadata-payment-intent-events
Narayanbhat166 Jul 2, 2024
f4fca06
merged main
tsdk02 Jul 2, 2024
737bd39
merged main
tsdk02 Jul 2, 2024
2087869
Converted metadata into string format, updated password credential fo…
tsdk02 Jul 2, 2024
f278042
resolved comments
tsdk02 Jul 3, 2024
50bea39
Merge branch 'main' into add-metadata-payment-intent-events
tsdk02 Jul 3, 2024
39137f0
resolved comments
tsdk02 Jul 3, 2024
a8d0bcb
minor errors resolved
tsdk02 Jul 3, 2024
ee20600
Merge branch 'main' into add-metadata-payment-intent-events
lsampras Jul 5, 2024
91fca4d
chore: run formatter
hyperswitch-bot[bot] Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/api_models/src/payments.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ pub struct PaymentsRequest {

/// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
#[schema(value_type = Option<Object>, example = r#"{ "udf1": "some-value", "udf2": "some-value" }"#)]
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'd intentionally kept this a Secret since this was a field provided by the merchant, and to not expose possible sensitive information in application logs. If we're now removing the Secret, we may have to consider masking possible sensitive information to our best efforts, both in application logs and in ClickHouse events.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding an issue for this #5227 .
we need to add consistency for this,
either by masking/hashing/encrypting it everywhere and deciding on a proper way for this


/// Some connectors like Apple pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.
pub connector_metadata: Option<ConnectorMetadata>,
Expand Down Expand Up @@ -3546,7 +3546,7 @@ pub struct PaymentsResponse {

/// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
#[schema(value_type = Option<Object>, example = r#"{ "udf1": "some-value", "udf2": "some-value" }"#)]
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,

/// additional data related to some connectors
#[schema(value_type = Option<ConnectorMetadata>)]
Expand Down
10 changes: 5 additions & 5 deletions crates/diesel_models/src/payment_intent.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pub struct PaymentIntent {
pub customer_id: Option<id_type::CustomerId>,
pub description: Option<String>,
pub return_url: Option<String>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub connector_id: Option<String>,
pub shipping_address_id: Option<String>,
pub billing_address_id: Option<String>,
Expand Down Expand Up @@ -76,7 +76,7 @@ pub struct PaymentIntentNew {
pub customer_id: Option<id_type::CustomerId>,
pub description: Option<String>,
pub return_url: Option<String>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub connector_id: Option<String>,
pub shipping_address_id: Option<String>,
pub billing_address_id: Option<String>,
Expand Down Expand Up @@ -129,7 +129,7 @@ pub enum PaymentIntentUpdate {
incremental_authorization_allowed: Option<bool>,
},
MetadataUpdate {
metadata: pii::SecretSerdeValue,
metadata: serde_json::Value,
updated_by: String,
},
PaymentCreateUpdate {
Expand Down Expand Up @@ -167,7 +167,7 @@ pub enum PaymentIntentUpdate {
statement_descriptor_name: Option<String>,
statement_descriptor_suffix: Option<String>,
order_details: Option<Vec<pii::SecretSerdeValue>>,
metadata: Option<pii::SecretSerdeValue>,
metadata: Option<serde_json::Value>,
payment_confirm_source: Option<storage_enums::PaymentSource>,
updated_by: String,
session_expiry: Option<PrimitiveDateTime>,
Expand Down Expand Up @@ -227,7 +227,7 @@ pub struct PaymentIntentUpdateInternal {
pub return_url: Option<String>,
pub setup_future_usage: Option<storage_enums::FutureUsage>,
pub off_session: Option<bool>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub billing_address_id: Option<String>,
pub shipping_address_id: Option<String>,
pub modified_at: Option<PrimitiveDateTime>,
Expand Down
2 changes: 1 addition & 1 deletion crates/hyperswitch_domain_models/src/payments.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub struct PaymentIntent {
pub customer_id: Option<id_type::CustomerId>,
pub description: Option<String>,
pub return_url: Option<String>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub connector_id: Option<String>,
pub shipping_address_id: Option<String>,
pub billing_address_id: Option<String>,
Expand Down
8 changes: 4 additions & 4 deletions crates/hyperswitch_domain_models/src/payments/payment_intent.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ pub struct PaymentIntentNew {
pub customer_id: Option<id_type::CustomerId>,
pub description: Option<String>,
pub return_url: Option<String>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub frm_metadata: Option<pii::SecretSerdeValue>,
pub connector_id: Option<String>,
pub shipping_address_id: Option<String>,
Expand Down Expand Up @@ -147,7 +147,7 @@ pub enum PaymentIntentUpdate {
incremental_authorization_allowed: Option<bool>,
},
MetadataUpdate {
metadata: pii::SecretSerdeValue,
metadata: serde_json::Value,
updated_by: String,
},
PaymentCreateUpdate {
Expand Down Expand Up @@ -185,7 +185,7 @@ pub enum PaymentIntentUpdate {
statement_descriptor_name: Option<String>,
statement_descriptor_suffix: Option<String>,
order_details: Option<Vec<pii::SecretSerdeValue>>,
metadata: Option<pii::SecretSerdeValue>,
metadata: Option<serde_json::Value>,
frm_metadata: Option<pii::SecretSerdeValue>,
payment_confirm_source: Option<storage_enums::PaymentSource>,
updated_by: String,
Expand Down Expand Up @@ -244,7 +244,7 @@ pub struct PaymentIntentUpdateInternal {
pub return_url: Option<String>,
pub setup_future_usage: Option<storage_enums::FutureUsage>,
pub off_session: Option<bool>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub billing_address_id: Option<String>,
pub shipping_address_id: Option<String>,
pub modified_at: Option<PrimitiveDateTime>,
Expand Down
8 changes: 4 additions & 4 deletions crates/hyperswitch_domain_models/src/router_request_types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ pub struct PaymentsAuthorizeData {
pub surcharge_details: Option<SurchargeDetails>,
pub customer_id: Option<String>,
pub request_incremental_authorization: bool,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub authentication_data: Option<AuthenticationData>,
pub charges: Option<PaymentCharges>,

Expand All @@ -80,7 +80,7 @@ pub struct PaymentsCaptureData {
pub multiple_capture_data: Option<MultipleCaptureRequestData>,
pub connector_meta: Option<serde_json::Value>,
pub browser_info: Option<BrowserInformation>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
// This metadata is used to store the metadata shared during the payment intent request.

// New amount for amount frame work
Expand Down Expand Up @@ -324,7 +324,7 @@ pub struct CompleteAuthorizeData {
pub connector_transaction_id: Option<String>,
pub connector_meta: Option<serde_json::Value>,
pub complete_authorize_url: Option<String>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,

// New amount for amount frame work
pub minor_amount: MinorUnit,
Expand Down Expand Up @@ -365,7 +365,7 @@ pub struct PaymentsCancelData {
pub cancellation_reason: Option<String>,
pub connector_meta: Option<serde_json::Value>,
pub browser_info: Option<BrowserInformation>,
pub metadata: Option<pii::SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
// This metadata is used to store the metadata shared during the payment intent request.

// minor amount data for amount framework
Expand Down
4 changes: 2 additions & 2 deletions crates/router/src/compatibility/stripe/payment_intents/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ pub struct StripePaymentIntentRequest {
pub shipping: Option<Shipping>,
pub statement_descriptor: Option<String>,
pub statement_descriptor_suffix: Option<String>,
pub metadata: Option<SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub client_secret: Option<masking::Secret<String>>,
pub payment_method_options: Option<StripePaymentMethodOptions>,
pub merchant_connector_details: Option<admin::MerchantConnectorDetailsWrap>,
Expand Down Expand Up @@ -478,7 +478,7 @@ pub struct StripePaymentIntentResponse {
pub customer: Option<id_type::CustomerId>,
pub refunds: Option<Vec<stripe_refunds::StripeRefundResponse>>,
pub mandate: Option<String>,
pub metadata: Option<SecretSerdeValue>,
pub metadata: Option<serde_json::Value>,
pub charges: Charges,
pub connector: Option<String>,
pub description: Option<String>,
Expand Down
2 changes: 1 addition & 1 deletion crates/router/src/compatibility/stripe/setup_intents/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ pub struct StripeSetupIntentResponse {
pub object: String,
pub status: StripeSetupStatus,
pub client_secret: Option<masking::Secret<String>>,
pub metadata: Option<secret::SecretSerdeValue>,
pub metadata: Option<Value>,
#[serde(with = "common_utils::custom_serde::iso8601::option")]
pub created: Option<time::PrimitiveDateTime>,
pub customer: Option<id_type::CustomerId>,
Expand Down
20 changes: 10 additions & 10 deletions crates/router/src/connector/adyen/transformers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2609,7 +2609,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
})
}
}
Expand Down Expand Up @@ -2671,7 +2671,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
})
}
}
Expand Down Expand Up @@ -2724,7 +2724,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
};
Ok(request)
}
Expand Down Expand Up @@ -2778,7 +2778,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
};
Ok(request)
}
Expand Down Expand Up @@ -2828,7 +2828,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
};
Ok(request)
}
Expand Down Expand Up @@ -2878,7 +2878,7 @@ impl<'a>
social_security_number: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
};
Ok(request)
}
Expand Down Expand Up @@ -2938,7 +2938,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
})
}
}
Expand Down Expand Up @@ -3033,7 +3033,7 @@ impl<'a>
channel,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
})
}
}
Expand Down Expand Up @@ -3108,7 +3108,7 @@ impl<'a>
channel: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
})
}
}
Expand Down Expand Up @@ -3166,7 +3166,7 @@ impl<'a>
social_security_number: None,
shopper_statement: item.router_data.request.statement_descriptor.clone(),
shopper_ip: item.router_data.request.get_ip_address_as_optional(),
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
})
}
}
Expand Down
72 changes: 43 additions & 29 deletions crates/router/src/connector/bankofamerica/transformers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,10 +941,12 @@ impl
specification_version: three_ds_info.three_ds_data.specification_version,
});

let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = item
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);

Ok(Self {
processing_information,
Expand Down Expand Up @@ -976,10 +978,12 @@ impl
let payment_information = PaymentInformation::try_from(&ccard)?;
let processing_information = ProcessingInformation::try_from((item, None, None))?;
let client_reference_information = ClientReferenceInformation::from(item);
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = item
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);

Ok(Self {
processing_information,
Expand Down Expand Up @@ -1017,10 +1021,12 @@ impl
))?;
let client_reference_information = ClientReferenceInformation::from(item);
let payment_information = PaymentInformation::try_from(&apple_pay_data)?;
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = item
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);
let ucaf_collection_indicator = match apple_pay_wallet_data
.payment_method
.network
Expand Down Expand Up @@ -1068,10 +1074,12 @@ impl
let processing_information =
ProcessingInformation::try_from((item, Some(PaymentSolution::GooglePay), None))?;
let client_reference_information = ClientReferenceInformation::from(item);
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = item
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);

Ok(Self {
processing_information,
Expand Down Expand Up @@ -1132,7 +1140,7 @@ impl TryFrom<&BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>>
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(
metadata.peek().to_owned(),
metadata,
)
});
let ucaf_collection_indicator = match apple_pay_data
Expand Down Expand Up @@ -1307,10 +1315,12 @@ impl
payment_instrument,
}));
let client_reference_information = ClientReferenceInformation::from(item);
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = item
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);
Ok(Self {
processing_information,
payment_information,
Expand Down Expand Up @@ -2610,10 +2620,12 @@ impl TryFrom<&BankOfAmericaRouterData<&types::PaymentsCaptureRouterData>>
fn try_from(
value: &BankOfAmericaRouterData<&types::PaymentsCaptureRouterData>,
) -> Result<Self, Self::Error> {
let merchant_defined_information =
value.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = value
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);
Ok(Self {
order_information: OrderInformation {
amount_details: Amount {
Expand Down Expand Up @@ -2653,10 +2665,12 @@ impl TryFrom<&BankOfAmericaRouterData<&types::PaymentsCancelRouterData>>
fn try_from(
value: &BankOfAmericaRouterData<&types::PaymentsCancelRouterData>,
) -> Result<Self, Self::Error> {
let merchant_defined_information =
value.router_data.request.metadata.clone().map(|metadata| {
Vec::<MerchantDefinedInformation>::foreign_from(metadata.peek().to_owned())
});
let merchant_defined_information = value
.router_data
.request
.metadata
.clone()
.map(Vec::<MerchantDefinedInformation>::foreign_from);
Ok(Self {
client_reference_information: ClientReferenceInformation {
code: Some(value.router_data.connector_request_reference_id.clone()),
Expand Down
2 changes: 1 addition & 1 deletion crates/router/src/connector/billwerk/transformers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ impl TryFrom<&BillwerkRouterData<&types::PaymentsAuthorizeRouterData>> for Billw
first_name: item.router_data.get_optional_billing_first_name(),
last_name: item.router_data.get_optional_billing_last_name(),
},
metadata: item.router_data.request.metadata.clone(),
metadata: item.router_data.request.metadata.clone().map(Into::into),
settle: item.router_data.request.is_auto_capture()?,
})
}
Expand Down
Loading