feat(router): added dispute accept api, file module apis and dispute evidence submission api (#900)

Co-authored-by: Sangamesh <[email protected]>
Co-authored-by: sai harsha <[email protected]>
Co-authored-by: Arun Raj M <[email protected]>

Author: 4 people

config/config.example.toml

@@ -169,6 +169,7 @@ payu.base_url = "https://secure.snd.payu.com/"
 rapyd.base_url = "https://sandboxapi.rapyd.net"
 shift4.base_url = "https://api.shift4.com/"
 stripe.base_url = "https://api.stripe.com/"
+stripe.base_url_file_upload = "https://files.stripe.com/"
 worldline.base_url = "https://eu.sandbox.api-ingenico.com/"
 worldpay.base_url = "https://try.access.worldpay.com/"
 trustpay.base_url = "https://test-tpgw.trustpay.eu/"

config/development.toml

@@ -122,6 +122,7 @@ payu.base_url = "https://secure.snd.payu.com/"
 rapyd.base_url = "https://sandboxapi.rapyd.net"
 shift4.base_url = "https://api.shift4.com/"
 stripe.base_url = "https://api.stripe.com/"
+stripe.base_url_file_upload = "https://files.stripe.com/"
 worldline.base_url = "https://eu.sandbox.api-ingenico.com/"
 worldpay.base_url = "https://try.access.worldpay.com/"
 trustpay.base_url = "https://test-tpgw.trustpay.eu/"
@@ -185,6 +186,10 @@ paypal = { currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" }
 google_pay = { country = "AL,DZ,AS,AO,AG,AR,AU,AT,AZ,BH,BY,BE,BR,BG,CA,CL,CO,HR,CZ,DK,DO,EG,EE,FI,FR,DE,GR,HK,HU,IN,ID,IE,IL,IT,JP,JO,KZ,KE,KW,LV,LB,LT,LU,MY,MX,NL,NZ,NO,OM,PK,PA,PE,PH,PL,PT,QA,RO,RU,SA,SG,SK,ZA,ES,LK,SE,CH,TW,TH,TR,UA,AE,GB,US,UY,VN" }
 apple_pay = { country = "AU,CN,HK,JP,MO,MY,NZ,SG,TW,AM,AT,AZ,BY,BE,BG,HR,CY,CZ,DK,EE,FO,FI,FR,GE,DE,GR,GL,GG,HU,IS,IE,IM,IT,KZ,JE,LV,LI,LT,LU,MT,MD,MC,ME,NL,NO,PL,PT,RO,SM,RS,SK,SI,ES,SE,CH,UA,GB,AR,CO,CR,BR,MX,PE,BH,IL,JO,KW,PS,QA,SA,AE,CA,UM,US" }
 
+[file_upload_config]
+bucket_name = ""
+region = ""
+
 [tokenization]
 stripe = { long_lived_token = false, payment_method = "wallet"}
 checkout = { long_lived_token = false, payment_method = "wallet"}

config/docker_compose.toml

@@ -96,6 +96,7 @@ payu.base_url = "https://secure.snd.payu.com/"
 rapyd.base_url = "https://sandboxapi.rapyd.net"
 shift4.base_url = "https://api.shift4.com/"
 stripe.base_url = "https://api.stripe.com/"
+stripe.base_url_file_upload = "https://files.stripe.com/"
 worldline.base_url = "https://eu.sandbox.api-ingenico.com/"
 worldpay.base_url = "https://try.access.worldpay.com/"
 trustpay.base_url = "https://test-tpgw.trustpay.eu/"

crates/api_models/src/disputes.rs

@@ -73,3 +73,57 @@ pub struct DisputeListConstraints {
     #[serde(rename = "received_time.gte")]
     pub received_time_gte: Option<PrimitiveDateTime>,
 }
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, ToSchema)]
+pub struct SubmitEvidenceRequest {
+    ///Dispute Id
+    pub dispute_id: String,
+    /// Logs showing the usage of service by customer
+    pub access_activity_log: Option<String>,
+    /// Billing address of the customer
+    pub billing_address: Option<String>,
+    /// File Id of cancellation policy
+    pub cancellation_policy: Option<String>,
+    /// Details of showing cancellation policy to customer before purchase
+    pub cancellation_policy_disclosure: Option<String>,
+    /// Details telling why customer's subscription was not cancelled
+    pub cancellation_rebuttal: Option<String>,
+    /// File Id of customer communication
+    pub customer_communication: Option<String>,
+    /// Customer email address
+    pub customer_email_address: Option<String>,
+    /// Customer name
+    pub customer_name: Option<String>,
+    /// IP address of the customer
+    pub customer_purchase_ip: Option<String>,
+    /// Fild Id of customer signature
+    pub customer_signature: Option<String>,
+    /// Product Description
+    pub product_description: Option<String>,
+    /// File Id of receipt
+    pub receipt: Option<String>,
+    /// File Id of refund policy
+    pub refund_policy: Option<String>,
+    /// Details of showing refund policy to customer before purchase
+    pub refund_policy_disclosure: Option<String>,
+    /// Details why customer is not entitled to refund
+    pub refund_refusal_explanation: Option<String>,
+    /// Customer service date
+    pub service_date: Option<String>,
+    /// File Id service documentation
+    pub service_documentation: Option<String>,
+    /// Shipping address of the customer
+    pub shipping_address: Option<String>,
+    /// Delivery service that shipped the product
+    pub shipping_carrier: Option<String>,
+    /// Shipping date
+    pub shipping_date: Option<String>,
+    /// File Id shipping documentation
+    pub shipping_documentation: Option<String>,
+    /// Tracking number of shipped product
+    pub shipping_tracking_number: Option<String>,
+    /// Any additional supporting file
+    pub uncategorized_file: Option<String>,
+    /// Any additional evidence statements
+    pub uncategorized_text: Option<String>,
+}

crates/api_models/src/enums.rs

@@ -625,6 +625,9 @@ impl Connector {
                 | (Self::Trustpay, PaymentMethod::BankRedirect)
         )
     }
+    pub fn supports_file_storage_module(&self) -> bool {
+        matches!(self, Self::Stripe)
+    }
 }
 
 #[derive(

crates/api_models/src/files.rs

@@ -1 +1,7 @@
+use utoipa::ToSchema;
 
+#[derive(Debug, serde::Serialize, ToSchema)]
+pub struct CreateFileResponse {
+    /// ID of the file created
+    pub file_id: String,
+}

crates/router/Cargo.toml

@@ -11,11 +11,12 @@ build = "src/build.rs"
 
 [features]
 default = ["kv_store", "stripe", "oltp", "olap", "accounts_cache"]
+s3 = []
 kms = ["external_services/kms"]
 basilisk = ["kms"]
 stripe = ["dep:serde_qs"]
-sandbox = ["kms", "stripe", "basilisk"]
-production = ["kms", "stripe", "basilisk"]
+sandbox = ["kms", "stripe", "basilisk", "s3"]
+production = ["kms", "stripe", "basilisk", "s3"]
 olap = []
 oltp = []
 kv_store = []
@@ -60,7 +61,7 @@ num_cpus = "1.15.0"
 once_cell = "1.17.1"
 rand = "0.8.5"
 regex = "1.7.3"
-reqwest = { version = "0.11.16", features = ["json", "native-tls", "gzip"] }
+reqwest = { version = "0.11.16", features = ["json", "native-tls", "gzip", "multipart"] }
 ring = "0.16.20"
 serde = { version = "1.0.160", features = ["derive"] }
 serde_json = "1.0.96"
@@ -88,6 +89,10 @@ redis_interface = { version = "0.1.0", path = "../redis_interface" }
 router_derive = { version = "0.1.0", path = "../router_derive" }
 router_env = { version = "0.1.0", path = "../router_env", features = ["log_extra_implicit_fields", "log_custom_entries_to_extra"] }
 storage_models = { version = "0.1.0", path = "../storage_models", features = ["kv_store"] }
+actix-multipart = "0.6.0"
+aws-sdk-s3 = "0.25.0"
+aws-config = "0.55.1"
+infer = "0.13.0"
 
 [build-dependencies]
 router_env = { version = "0.1.0", path = "../router_env", default-features = false }

crates/router/src/compatibility/stripe/errors.rs

@@ -182,6 +182,20 @@ pub enum StripeErrorCode {
     IncorrectConnectorNameGiven,
     #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "No such {object}: '{id}'")]
     ResourceMissing { object: String, id: String },
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "File validation failed")]
+    FileValidationFailed,
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "File not found in the request")]
+    MissingFile,
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "File puropse not found in the request")]
+    MissingFilePurpose,
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "File content type not found")]
+    MissingFileContentType,
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "Dispute id not found in the request")]
+    MissingDisputeId,
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "File does not exists in our records")]
+    FileNotFound,
+    #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "File not available")]
+    FileNotAvailable,
     // [#216]: https://github.com/juspay/hyperswitch/issues/216
     // Implement the remaining stripe error codes
 
@@ -466,6 +480,16 @@ impl From<errors::ApiErrorResponse> for StripeErrorCode {
                 object: "dispute".to_owned(),
                 id: dispute_id,
             },
+            errors::ApiErrorResponse::DisputeStatusValidationFailed { reason } => {
+                Self::InternalServerError
+            }
+            errors::ApiErrorResponse::FileValidationFailed { .. } => Self::FileValidationFailed,
+            errors::ApiErrorResponse::MissingFile => Self::MissingFile,
+            errors::ApiErrorResponse::MissingFilePurpose => Self::MissingFilePurpose,
+            errors::ApiErrorResponse::MissingFileContentType => Self::MissingFileContentType,
+            errors::ApiErrorResponse::MissingDisputeId => Self::MissingDisputeId,
+            errors::ApiErrorResponse::FileNotFound => Self::FileNotFound,
+            errors::ApiErrorResponse::FileNotAvailable => Self::FileNotAvailable,
             errors::ApiErrorResponse::NotSupported { .. } => Self::InternalServerError,
         }
     }
@@ -514,7 +538,14 @@ impl actix_web::ResponseError for StripeErrorCode {
             | Self::PaymentIntentUnexpectedState { .. }
             | Self::DuplicatePayment { .. }
             | Self::IncorrectConnectorNameGiven
-            | Self::ResourceMissing { .. } => StatusCode::BAD_REQUEST,
+            | Self::ResourceMissing { .. }
+            | Self::FileValidationFailed
+            | Self::MissingFile
+            | Self::MissingFileContentType
+            | Self::MissingFilePurpose
+            | Self::MissingDisputeId
+            | Self::FileNotFound
+            | Self::FileNotAvailable => StatusCode::BAD_REQUEST,
             Self::RefundFailed
             | Self::InternalServerError
             | Self::MandateActive

crates/router/src/compatibility/wrap.rs

@@ -56,6 +56,9 @@ where
         }
         Ok(api::ApplicationResponse::StatusOk) => api::http_response_ok(),
         Ok(api::ApplicationResponse::TextPlain(text)) => api::http_response_plaintext(text),
+        Ok(api::ApplicationResponse::FileData((file_data, content_type))) => {
+            api::http_response_file_data(file_data, content_type)
+        }
         Ok(api::ApplicationResponse::JsonForRedirection(response)) => {
             match serde_json::to_string(&response) {
                 Ok(res) => api::http_redirect_response(res, response),

crates/router/src/configs/settings.rs

@@ -62,6 +62,8 @@ pub struct Settings {
     pub api_keys: ApiKeys,
     #[cfg(feature = "kms")]
     pub kms: kms::KmsConfig,
+    #[cfg(feature = "s3")]
+    pub file_upload_config: FileUploadConfig,
     pub tokenization: TokenizationConfig,
 }
 
@@ -306,7 +308,7 @@ pub struct Connectors {
     pub payu: ConnectorParams,
     pub rapyd: ConnectorParams,
     pub shift4: ConnectorParams,
-    pub stripe: ConnectorParams,
+    pub stripe: ConnectorParamsWithFileUploadUrl,
     pub worldline: ConnectorParams,
     pub worldpay: ConnectorParams,
     pub trustpay: ConnectorParamsWithMoreUrls,
@@ -328,6 +330,13 @@ pub struct ConnectorParamsWithMoreUrls {
     pub base_url_bank_redirects: String,
 }
 
+#[derive(Debug, Deserialize, Clone, Default)]
+#[serde(default)]
+pub struct ConnectorParamsWithFileUploadUrl {
+    pub base_url: String,
+    pub base_url_file_upload: String,
+}
+
 #[derive(Debug, Clone, Deserialize)]
 #[serde(default)]
 pub struct SchedulerSettings {
@@ -387,6 +396,16 @@ pub struct ApiKeys {
     pub hash_key: String,
 }
 
+#[cfg(feature = "s3")]
+#[derive(Debug, Deserialize, Clone, Default)]
+#[serde(default)]
+pub struct FileUploadConfig {
+    /// The AWS region to send file uploads
+    pub region: String,
+    /// The AWS s3 bucket to send file uploads
+    pub bucket_name: String,
+}
+
 impl Settings {
     pub fn new() -> ApplicationResult<Self> {
         Self::with_config_path(None)
@@ -465,7 +484,8 @@ impl Settings {
         self.kms
             .validate()
             .map_err(|error| ApplicationError::InvalidConfigurationValueError(error.into()))?;
-
+        #[cfg(feature = "s3")]
+        self.file_upload_config.validate()?;
         Ok(())
     }
 }