feat(recovery): add support for custom billing api for v2 (#8838)

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

Author: 3 people

crates/api_models/src/events/payment.rs

@@ -4,6 +4,7 @@ use common_utils::events::{ApiEventMetric, ApiEventsType};
 use super::{
     PaymentAttemptListRequest, PaymentAttemptListResponse, PaymentStartRedirectionRequest,
     PaymentsCreateIntentRequest, PaymentsGetIntentRequest, PaymentsIntentResponse, PaymentsRequest,
+    RecoveryPaymentsCreate, RecoveryPaymentsResponse,
 };
 #[cfg(feature = "v2")]
 use crate::payment_methods::{
@@ -416,6 +417,20 @@ impl ApiEventMetric for PaymentListResponse {
     }
 }
 
+#[cfg(feature = "v2")]
+impl ApiEventMetric for RecoveryPaymentsCreate {
+    fn get_api_event_type(&self) -> Option<ApiEventsType> {
+        None
+    }
+}
+
+#[cfg(feature = "v2")]
+impl ApiEventMetric for RecoveryPaymentsResponse {
+    fn get_api_event_type(&self) -> Option<ApiEventsType> {
+        None
+    }
+}
+
 #[cfg(feature = "v1")]
 impl ApiEventMetric for PaymentListResponseV2 {
     fn get_api_event_type(&self) -> Option<ApiEventsType> {
@@ -496,7 +511,6 @@ impl ApiEventMetric for payments::PaymentMethodListResponseForPayments {
         None
     }
 }
-
 #[cfg(feature = "v2")]
 impl ApiEventMetric for PaymentMethodListResponseForSession {}
 

crates/api_models/src/payments.rs

@@ -1696,6 +1696,32 @@ pub struct PaymentAttemptRecordResponse {
     pub created_at: PrimitiveDateTime,
 }
 
+#[cfg(feature = "v2")]
+#[derive(Debug, serde::Serialize, Clone, ToSchema)]
+pub struct RecoveryPaymentsResponse {
+    /// Unique identifier for the payment.
+    #[schema(
+        min_length = 30,
+        max_length = 30,
+        example = "pay_mbabizu24mvu3mela5njyhpit4",
+        value_type = String,
+    )]
+    pub id: id_type::GlobalPaymentId,
+
+    #[schema(value_type = IntentStatus, example = "failed", default = "requires_confirmation")]
+    pub intent_status: api_enums::IntentStatus,
+
+    /// Unique identifier for the payment. This ensures idempotency for multiple payments
+    /// that have been done by a single merchant.
+    #[schema(
+        value_type = Option<String>,
+        min_length = 30,
+        max_length = 30,
+        example = "pay_mbabizu24mvu3mela5njyhpit4"
+    )]
+    pub merchant_reference_id: Option<id_type::PaymentReferenceId>,
+}
+
 #[cfg(feature = "v2")]
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, PartialEq, ToSchema)]
 pub struct PaymentAttemptFeatureMetadata {
@@ -4318,6 +4344,12 @@ pub struct PaymentMethodDataResponseWithBilling {
     pub billing: Option<Address>,
 }
 
+#[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, ToSchema, serde::Serialize)]
+pub struct CustomRecoveryPaymentMethodData {
+    #[serde(flatten)]
+    pub units: HashMap<String, AdditionalCardInfo>,
+}
+
 #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
 #[cfg(feature = "v1")]
 pub enum PaymentIdType {
@@ -9100,6 +9132,78 @@ pub struct PaymentsAttemptRecordRequest {
     pub card_issuer: Option<String>,
 }
 
+// Serialize is required because the api event requires Serialize to be implemented
+#[derive(Debug, serde::Serialize, serde::Deserialize, Clone, ToSchema)]
+#[serde(deny_unknown_fields)]
+#[cfg(feature = "v2")]
+pub struct RecoveryPaymentsCreate {
+    /// The amount details for the payment
+    pub amount_details: AmountDetails,
+
+    /// Unique identifier for the payment. This ensures idempotency for multiple payments
+    /// that have been done by a single merchant.
+    #[schema(
+        value_type = Option<String>,
+        min_length = 30,
+        max_length = 30,
+        example = "pay_mbabizu24mvu3mela5njyhpit4"
+    )]
+    pub merchant_reference_id: id_type::PaymentReferenceId,
+
+    /// Error details for the payment if any
+    pub error: Option<ErrorDetails>,
+
+    /// Billing connector id to update the invoices.
+    #[schema(value_type = String, example = "mca_1234567890")]
+    pub billing_merchant_connector_id: id_type::MerchantConnectorAccountId,
+
+    /// Payments connector id to update the invoices.
+    #[schema(value_type = String, example = "mca_1234567890")]
+    pub payment_merchant_connector_id: id_type::MerchantConnectorAccountId,
+
+    #[schema(value_type = AttemptStatus, example = "charged")]
+    pub attempt_status: enums::AttemptStatus,
+
+    /// The billing details of the payment attempt.
+    pub billing: Option<Address>,
+
+    /// The payment method subtype to be used for the payment. This should match with the `payment_method_data` provided
+    #[schema(value_type = PaymentMethodType, example = "apple_pay")]
+    pub payment_method_sub_type: api_enums::PaymentMethodType,
+
+    /// primary payment method token at payment processor end.
+    #[schema(value_type = String, example = "token_1234")]
+    pub primary_processor_payment_method_token: Secret<String>,
+
+    /// The time at which payment attempt was created.
+    #[schema(example = "2022-09-10T10:11:12Z")]
+    #[serde(default, with = "common_utils::custom_serde::iso8601::option")]
+    pub transaction_created_at: Option<PrimitiveDateTime>,
+
+    /// Payment method type for the payment attempt
+    #[schema(value_type = Option<PaymentMethod>, example = "wallet")]
+    pub payment_method_type: common_enums::PaymentMethod,
+
+    /// customer id at payment connector for which mandate is attached.
+    #[schema(value_type = String, example = "cust_12345")]
+    pub connector_customer_id: Secret<String>,
+
+    /// Invoice billing started at billing connector end.
+    #[schema(example = "2022-09-10T10:11:12Z")]
+    #[serde(default, with = "common_utils::custom_serde::iso8601::option")]
+    pub billing_started_at: Option<PrimitiveDateTime>,
+
+    /// A unique identifier for a payment provided by the payment connector
+    #[schema(value_type = Option<String>, example = "993672945374576J")]
+    pub connector_transaction_id: Option<Secret<String>>,
+
+    /// payment method token units at payment processor end.
+    pub payment_method_units: CustomRecoveryPaymentMethodData,
+
+    /// Type of action that needs to be taken after consuming the recovery payload. For example: scheduling a failed payment or stopping the invoice.
+    pub action: common_payments_types::RecoveryAction,
+}
+
 /// Error details for the payment
 #[cfg(feature = "v2")]
 #[derive(Debug, serde::Serialize, serde::Deserialize, Clone, ToSchema)]

crates/common_types/src/payments.rs

@@ -525,3 +525,21 @@ impl ApplePayPredecryptData {
         Ok(Secret::new(format!("{month}{year}")))
     }
 }
+
+/// type of action that needs to taken after consuming recovery payload
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
+pub enum RecoveryAction {
+    /// Stops the process tracker and update the payment intent.
+    CancelInvoice,
+    /// Records the external transaction against payment intent.
+    ScheduleFailedPayment,
+    /// Records the external payment and stops the internal process tracker.
+    SuccessPaymentExternal,
+    /// Pending payments from billing processor.
+    PendingPayment,
+    /// No action required.
+    NoAction,
+    /// Invalid event has been received.
+    InvalidAction,
+}

crates/hyperswitch_connectors/src/connectors/custombilling.rs

@@ -36,7 +36,6 @@ use hyperswitch_interfaces::{
     types::{self, Response},
     webhooks,
 };
-use masking::{ExposeInterface, Mask};
 use transformers as custombilling;
 
 use crate::{constants::headers, types::ResponseRouterData, utils};
@@ -114,14 +113,9 @@ impl ConnectorCommon for Custombilling {
 
     fn get_auth_header(
         &self,
-        auth_type: &ConnectorAuthType,
+        _auth_type: &ConnectorAuthType,
     ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
-        let auth = custombilling::CustombillingAuthType::try_from(auth_type)
-            .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
-        Ok(vec![(
-            headers::AUTHORIZATION.to_string(),
-            auth.api_key.expose().into_masked(),
-        )])
+        Ok(vec![])
     }
 
     fn build_error_response(

crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs

@@ -2,7 +2,7 @@ use common_enums::enums;
 use common_utils::types::StringMinorUnit;
 use hyperswitch_domain_models::{
     payment_method_data::PaymentMethodData,
-    router_data::{ConnectorAuthType, RouterData},
+    router_data::RouterData,
     router_flow_types::refunds::{Execute, RSync},
     router_request_types::ResponseId,
     router_response_types::{PaymentsResponseData, RefundsResponseData},
@@ -75,23 +75,6 @@ impl TryFrom<&CustombillingRouterData<&PaymentsAuthorizeRouterData>>
     }
 }
 
-//TODO: Fill the struct with respective fields
-// Auth Struct
-pub struct CustombillingAuthType {
-    pub(super) api_key: Secret<String>,
-}
-
-impl TryFrom<&ConnectorAuthType> for CustombillingAuthType {
-    type Error = error_stack::Report<errors::ConnectorError>;
-    fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> {
-        match auth_type {
-            ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
-                api_key: api_key.to_owned(),
-            }),
-            _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()),
-        }
-    }
-}
 // PaymentsResponse
 //TODO: Append the remaining status flags
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]

crates/hyperswitch_domain_models/src/revenue_recovery.rs

@@ -81,23 +81,6 @@ pub struct RevenueRecoveryInvoiceData {
     pub billing_started_at: Option<PrimitiveDateTime>,
 }
 
-/// type of action that needs to taken after consuming recovery payload
-#[derive(Debug)]
-pub enum RecoveryAction {
-    /// Stops the process tracker and update the payment intent.
-    CancelInvoice,
-    /// Records the external transaction against payment intent.
-    ScheduleFailedPayment,
-    /// Records the external payment and stops the internal process tracker.
-    SuccessPaymentExternal,
-    /// Pending payments from billing processor.
-    PendingPayment,
-    /// No action required.
-    NoAction,
-    /// Invalid event has been received.
-    InvalidAction,
-}
-
 #[derive(Clone, Debug)]
 pub struct RecoveryPaymentIntent {
     pub payment_id: id_type::GlobalPaymentId,
@@ -134,63 +117,6 @@ impl RecoveryPaymentAttempt {
     }
 }
 
-impl RecoveryAction {
-    pub fn get_action(
-        event_type: webhooks::IncomingWebhookEvent,
-        attempt_triggered_by: Option<common_enums::TriggeredBy>,
-    ) -> Self {
-        match event_type {
-            webhooks::IncomingWebhookEvent::PaymentIntentFailure
-            | webhooks::IncomingWebhookEvent::PaymentIntentSuccess
-            | webhooks::IncomingWebhookEvent::PaymentIntentProcessing
-            | webhooks::IncomingWebhookEvent::PaymentIntentPartiallyFunded
-            | webhooks::IncomingWebhookEvent::PaymentIntentCancelled
-            | webhooks::IncomingWebhookEvent::PaymentIntentCancelFailure
-            | webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess
-            | webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationFailure
-            | webhooks::IncomingWebhookEvent::PaymentIntentCaptureSuccess
-            | webhooks::IncomingWebhookEvent::PaymentIntentCaptureFailure
-            | webhooks::IncomingWebhookEvent::PaymentIntentExpired
-            | webhooks::IncomingWebhookEvent::PaymentActionRequired
-            | webhooks::IncomingWebhookEvent::EventNotSupported
-            | webhooks::IncomingWebhookEvent::SourceChargeable
-            | webhooks::IncomingWebhookEvent::SourceTransactionCreated
-            | webhooks::IncomingWebhookEvent::RefundFailure
-            | webhooks::IncomingWebhookEvent::RefundSuccess
-            | webhooks::IncomingWebhookEvent::DisputeOpened
-            | webhooks::IncomingWebhookEvent::DisputeExpired
-            | webhooks::IncomingWebhookEvent::DisputeAccepted
-            | webhooks::IncomingWebhookEvent::DisputeCancelled
-            | webhooks::IncomingWebhookEvent::DisputeChallenged
-            | webhooks::IncomingWebhookEvent::DisputeWon
-            | webhooks::IncomingWebhookEvent::DisputeLost
-            | webhooks::IncomingWebhookEvent::MandateActive
-            | webhooks::IncomingWebhookEvent::MandateRevoked
-            | webhooks::IncomingWebhookEvent::EndpointVerification
-            | webhooks::IncomingWebhookEvent::ExternalAuthenticationARes
-            | webhooks::IncomingWebhookEvent::FrmApproved
-            | webhooks::IncomingWebhookEvent::FrmRejected
-            | webhooks::IncomingWebhookEvent::PayoutSuccess
-            | webhooks::IncomingWebhookEvent::PayoutFailure
-            | webhooks::IncomingWebhookEvent::PayoutProcessing
-            | webhooks::IncomingWebhookEvent::PayoutCancelled
-            | webhooks::IncomingWebhookEvent::PayoutCreated
-            | webhooks::IncomingWebhookEvent::PayoutExpired
-            | webhooks::IncomingWebhookEvent::PayoutReversed => Self::InvalidAction,
-            webhooks::IncomingWebhookEvent::RecoveryPaymentFailure => match attempt_triggered_by {
-                Some(common_enums::TriggeredBy::Internal) => Self::NoAction,
-                Some(common_enums::TriggeredBy::External) | None => Self::ScheduleFailedPayment,
-            },
-            webhooks::IncomingWebhookEvent::RecoveryPaymentSuccess => match attempt_triggered_by {
-                Some(common_enums::TriggeredBy::Internal) => Self::NoAction,
-                Some(common_enums::TriggeredBy::External) | None => Self::SuccessPaymentExternal,
-            },
-            webhooks::IncomingWebhookEvent::RecoveryPaymentPending => Self::PendingPayment,
-            webhooks::IncomingWebhookEvent::RecoveryInvoiceCancel => Self::CancelInvoice,
-        }
-    }
-}
-
 impl From<&RevenueRecoveryInvoiceData> for api_payments::AmountDetails {
     fn from(data: &RevenueRecoveryInvoiceData) -> Self {
         let amount = api_payments::AmountDetailsSetter {